Cisco-IOS-XR-mpls-ldp-cfg API API Reference
API generated from Cisco-IOS-XR-mpls-ldp-cfg@2017-09-30.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
MPLS-LDP - Update
Update operation of resource: mpls-ldp
mpls-ldpbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ], "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Create
Create operation of resource: mpls-ldp
mpls-ldpbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ], "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Delete
Delete operation of resource: mpls-ldp
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Retrieve
Retrieve operation of resource: mpls-ldp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ], "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ]
}
}
DEFAULT-VRF - Update
Update operation of resource: default-vrf
default-vrfbody object
Request Content-Types: application/json
Request Example
{ { "disable": [ null ],
"timeout": "integer"
}
}
}
}, "disable-quick-start": [ null ], "dual-stack": "string",
"interval": "string",
"hold-time": "string"
}
}
},
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "disable": [ null ]
}, "address-type": "string",
"address": "string"
}
}, "disable-auto-config": [ null ]
}
}
]
}
}
]
}, "peer-acl-name": "string",
"type": "string"
}, "peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
},
"router-id": "string", "password": "string", "tlv-compliance": [ null ], "max-wait": "integer", "ipv4": [ null ]
}
}
}, {
"lsr-id": "string", "command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
]
}
}, "maintain-on-local-reset": "string"
}
}
}, {
"af-name": "string",
"enable": [ null ], {
"targeted": [ null ],
"ip-address": "string"
}
]
}
}, "group-all": [ null ], {
"mesh-group-id": "string"
}
]
}
}
}, "transport-address": "string", "peer-acl-name": "string",
"accept-type": "string"
}
}, "as-xx": "integer",
"as-yy": "integer"
}, "peer-acl-name": "string",
"type": "string"
}
}
}, {
"peer-acl-name": "string"
}
]
}
}
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Create
Create operation of resource: default-vrf
default-vrfbody object
Request Content-Types: application/json
Request Example
{ { "disable": [ null ],
"timeout": "integer"
}
}
}
}, "disable-quick-start": [ null ], "dual-stack": "string",
"interval": "string",
"hold-time": "string"
}
}
},
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "disable": [ null ]
}, "address-type": "string",
"address": "string"
}
}, "disable-auto-config": [ null ]
}
}
]
}
}
]
}, "peer-acl-name": "string",
"type": "string"
}, "peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
},
"router-id": "string", "password": "string", "tlv-compliance": [ null ], "max-wait": "integer", "ipv4": [ null ]
}
}
}, {
"lsr-id": "string", "command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
]
}
}, "maintain-on-local-reset": "string"
}
}
}, {
"af-name": "string",
"enable": [ null ], {
"targeted": [ null ],
"ip-address": "string"
}
]
}
}, "group-all": [ null ], {
"mesh-group-id": "string"
}
]
}
}
}, "transport-address": "string", "peer-acl-name": "string",
"accept-type": "string"
}
}, "as-xx": "integer",
"as-yy": "integer"
}, "peer-acl-name": "string",
"type": "string"
}
}
}, {
"peer-acl-name": "string"
}
]
}
}
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Delete
Delete operation of resource: default-vrf
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "disable": [ null ],
"timeout": "integer"
}
}
}
}, "disable-quick-start": [ null ], "dual-stack": "string",
"interval": "string",
"hold-time": "string"
}
}
},
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "disable": [ null ]
}, "address-type": "string",
"address": "string"
}
}, "disable-auto-config": [ null ]
}
}
]
}
}
]
}, "peer-acl-name": "string",
"type": "string"
}, "peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
},
"router-id": "string", "password": "string", "tlv-compliance": [ null ], "max-wait": "integer", "ipv4": [ null ]
}
}
}, {
"lsr-id": "string", "command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
]
}
}, "maintain-on-local-reset": "string"
}
}
}, {
"af-name": "string",
"enable": [ null ], {
"targeted": [ null ],
"ip-address": "string"
}
]
}
}, "group-all": [ null ], {
"mesh-group-id": "string"
}
]
}
}
}, "transport-address": "string", "peer-acl-name": "string",
"accept-type": "string"
}
}, "as-xx": "integer",
"as-yy": "integer"
}, "peer-acl-name": "string",
"type": "string"
}
}
}, {
"peer-acl-name": "string"
}
]
}
}
}
}
}
]
}
}
AFS - Update
Update operation of resource: afs
afsbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
AF - Update
Update operation of resource: af
afbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
LABEL - Update
Update operation of resource: label
labelbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}, { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Create
Create operation of resource: label
labelbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}, { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Delete
Delete operation of resource: label
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Retrieve
Retrieve operation of resource: label
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}, { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
}
}
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of af-name
Successful operation
Internal Error
ACCEPT - Update
Update operation of resource: accept
acceptbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Create
Create operation of resource: accept
acceptbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Delete
Delete operation of resource: accept
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Retrieve
Retrieve operation of resource: accept
ID of af-name
PEER-ACCEPT-POLICIES - Update
Update operation of resource: peer-accept-policies
peer-accept-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Create
Create operation of resource: peer-accept-policies
peer-accept-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Delete
Delete operation of resource: peer-accept-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Retrieve
Retrieve operation of resource: peer-accept-policies
ID of af-name
PEER-ACCEPT-POLICY - Update
Update operation of resource: peer-accept-policy
peer-accept-policybody object
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Create
Create operation of resource: peer-accept-policy
peer-accept-policybody object
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Delete
Delete operation of resource: peer-accept-policy
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Retrieve
Retrieve operation of resource: peer-accept-policy
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
LOCAL - Update
Update operation of resource: local
localbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Create
Create operation of resource: local
localbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Delete
Delete operation of resource: local
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Retrieve
Retrieve operation of resource: local
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}
ADVERTISE - Update
Update operation of resource: advertise
advertisebody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Create
Create operation of resource: advertise
advertisebody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Delete
Delete operation of resource: advertise
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Retrieve
Retrieve operation of resource: advertise
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
}
PEER-ADVERTISE-POLICIES - Update
Update operation of resource: peer-advertise-policies
peer-advertise-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Create
Create operation of resource: peer-advertise-policies
peer-advertise-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Delete
Delete operation of resource: peer-advertise-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Retrieve
Retrieve operation of resource: peer-advertise-policies
ID of af-name
PEER-ADVERTISE-POLICY - Update
Update operation of resource: peer-advertise-policy
peer-advertise-policybody object
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Create
Create operation of resource: peer-advertise-policy
peer-advertise-policybody object
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Delete
Delete operation of resource: peer-advertise-policy
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Retrieve
Retrieve operation of resource: peer-advertise-policy
ID of af-name
ID of lsr-id label-space-id
Successful operation
Internal Error
PREFIX-ADVERTISE-POLICIES - Update
Update operation of resource: prefix-advertise-policies
prefix-advertise-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICIES - Create
Create operation of resource: prefix-advertise-policies
prefix-advertise-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICIES - Delete
Delete operation of resource: prefix-advertise-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICIES - Retrieve
Retrieve operation of resource: prefix-advertise-policies
ID of af-name
Successful operation
Internal Error
PREFIX-ADVERTISE-POLICY - Update
Update operation of resource: prefix-advertise-policy
prefix-advertise-policybody object
ID of af-name
ID of prefix-acl-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"prefix-acl-name": "string",
"advertise-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICY - Create
Create operation of resource: prefix-advertise-policy
prefix-advertise-policybody object
ID of af-name
ID of prefix-acl-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"prefix-acl-name": "string",
"advertise-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICY - Delete
Delete operation of resource: prefix-advertise-policy
ID of af-name
ID of prefix-acl-name
Successful operation
Internal Error
Response Content-Types: application/json
PREFIX-ADVERTISE-POLICY - Retrieve
Retrieve operation of resource: prefix-advertise-policy
ID of af-name
ID of prefix-acl-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-acl-name": "string",
"prefix-acl-name": "string",
"advertise-type": "string"
}
EXPLICIT-NULL - Update
Update operation of resource: explicit-null
explicit-nullbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Create
Create operation of resource: explicit-null
explicit-nullbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Delete
Delete operation of resource: explicit-null
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Retrieve
Retrieve operation of resource: explicit-null
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of af-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of af-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of af-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of af-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
ALLOCATE - Update
Update operation of resource: allocate
allocatebody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"prefix-acl-name": "string",
"allocation-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Create
Create operation of resource: allocate
allocatebody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"prefix-acl-name": "string",
"allocation-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Delete
Delete operation of resource: allocate
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Retrieve
Retrieve operation of resource: allocate
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-acl-name": "string",
"allocation-type": "string"
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of af-name
Successful operation
Internal Error
TARGETED-HELLO-ACCEPT - Update
Update operation of resource: targeted-hello-accept
targeted-hello-acceptbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"accept-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO-ACCEPT - Create
Create operation of resource: targeted-hello-accept
targeted-hello-acceptbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"accept-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO-ACCEPT - Delete
Delete operation of resource: targeted-hello-accept
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO-ACCEPT - Retrieve
Retrieve operation of resource: targeted-hello-accept
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-acl-name": "string",
"accept-type": "string"
}
TRAFFIC-ENGINEERING - Update
Update operation of resource: traffic-engineering
traffic-engineeringbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Create
Create operation of resource: traffic-engineering
traffic-engineeringbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Delete
Delete operation of resource: traffic-engineering
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAFFIC-ENGINEERING - Retrieve
Retrieve operation of resource: traffic-engineering
ID of af-name
AUTO-TUNNEL-MESH - Update
Update operation of resource: auto-tunnel-mesh
auto-tunnel-meshbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-TUNNEL-MESH - Create
Create operation of resource: auto-tunnel-mesh
auto-tunnel-meshbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-TUNNEL-MESH - Delete
Delete operation of resource: auto-tunnel-mesh
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-TUNNEL-MESH - Retrieve
Retrieve operation of resource: auto-tunnel-mesh
ID of af-name
GROUP-IDS - Update
Update operation of resource: group-ids
group-idsbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-IDS - Create
Create operation of resource: group-ids
group-idsbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-IDS - Delete
Delete operation of resource: group-ids
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-IDS - Retrieve
Retrieve operation of resource: group-ids
ID of af-name
Successful operation
Internal Error
GROUP-ID - Update
Update operation of resource: group-id
group-idbody object
ID of af-name
ID of mesh-group-id
Request Content-Types: application/json
Request Example
{
"mesh-group-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-ID - Create
Create operation of resource: group-id
group-idbody object
ID of af-name
ID of mesh-group-id
Request Content-Types: application/json
Request Example
{
"mesh-group-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-ID - Delete
Delete operation of resource: group-id
ID of af-name
ID of mesh-group-id
Successful operation
Internal Error
Response Content-Types: application/json
GROUP-ID - Retrieve
Retrieve operation of resource: group-id
ID of af-name
ID of mesh-group-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mesh-group-id": "string"
}
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
ID of af-name
Successful operation
Internal Error
ADDRESSES - Update
Update operation of resource: addresses
addressesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Create
Create operation of resource: addresses
addressesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Delete
Delete operation of resource: addresses
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESSES - Retrieve
Retrieve operation of resource: addresses
ID of af-name
Successful operation
Internal Error
ADDRESS - Update
Update operation of resource: address
addressbody object
ID of af-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"targeted": [ null ],
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Create
Create operation of resource: address
addressbody object
ID of af-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"targeted": [ null ],
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Delete
Delete operation of resource: address
ID of af-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ADDRESS - Retrieve
Retrieve operation of resource: address
ID of af-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"targeted": [ null ],
"ip-address": "string"
}
REDISTRIBUTION-PROTOCOL - Update
Update operation of resource: redistribution-protocol
redistribution-protocolbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTION-PROTOCOL - Create
Create operation of resource: redistribution-protocol
redistribution-protocolbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTION-PROTOCOL - Delete
Delete operation of resource: redistribution-protocol
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTION-PROTOCOL - Retrieve
Retrieve operation of resource: redistribution-protocol
ID of af-name
Successful operation
Internal Error
BGP - Update
Update operation of resource: bgp
bgpbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Create
Create operation of resource: bgp
bgpbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Delete
Delete operation of resource: bgp
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Retrieve
Retrieve operation of resource: bgp
ID of af-name
AS - Update
Update operation of resource: as
asbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"as-xx": "integer",
"as-yy": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
AS - Create
Create operation of resource: as
asbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"as-xx": "integer",
"as-yy": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
AS - Delete
Delete operation of resource: as
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AS - Retrieve
Retrieve operation of resource: as
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"as-xx": "integer",
"as-yy": "integer"
}
ADVERTISE-TO - Update
Update operation of resource: advertise-to
advertise-tobody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE-TO - Create
Create operation of resource: advertise-to
advertise-tobody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE-TO - Delete
Delete operation of resource: advertise-to
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE-TO - Retrieve
Retrieve operation of resource: advertise-to
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-acl-name": "string",
"type": "string"
}
GLOBAL - Update
Update operation of resource: global
globalbody object
Request Content-Types: application/json
Request Example
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Create
Create operation of resource: global
globalbody object
Request Content-Types: application/json
Request Example
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Delete
Delete operation of resource: global
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Retrieve
Retrieve operation of resource: global
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
SESSION - Update
Update operation of resource: session
sessionbody object
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
PROTECTION - Update
Update operation of resource: protection
protectionbody object
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROTECTION - Create
Create operation of resource: protection
protectionbody object
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROTECTION - Delete
Delete operation of resource: protection
Successful operation
Internal Error
Response Content-Types: application/json
PROTECTION - Retrieve
Retrieve operation of resource: protection
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
DOWNSTREAM-ON-DEMAND - Update
Update operation of resource: downstream-on-demand
downstream-on-demandbody object
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Create
Create operation of resource: downstream-on-demand
downstream-on-demandbody object
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Delete
Delete operation of resource: downstream-on-demand
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Retrieve
Retrieve operation of resource: downstream-on-demand
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-acl-name": "string",
"type": "string"
}
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
Successful operation
Internal Error
LDP-IDS - Update
Update operation of resource: ldp-ids
ldp-idsbody object
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Create
Create operation of resource: ldp-ids
ldp-idsbody object
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Delete
Delete operation of resource: ldp-ids
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Retrieve
Retrieve operation of resource: ldp-ids
LDP-ID - Update
Update operation of resource: ldp-id
ldp-idbody object
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Create
Create operation of resource: ldp-id
ldp-idbody object
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Delete
Delete operation of resource: ldp-id
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
ID of lsr-id label-space-id
Successful operation
Internal Error
PASSWORD - Update
Update operation of resource: password
passwordbody object
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{
"command-type": "string",
"password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Create
Create operation of resource: password
passwordbody object
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{
"command-type": "string",
"password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Delete
Delete operation of resource: password
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Retrieve
Retrieve operation of resource: password
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"command-type": "string",
"password": "string"
}
DUAL-STACK - Update
Update operation of resource: dual-stack
dual-stackbody object
Successful operation
Internal Error
Response Content-Types: application/json
DUAL-STACK - Create
Create operation of resource: dual-stack
dual-stackbody object
Successful operation
Internal Error
Response Content-Types: application/json
DUAL-STACK - Delete
Delete operation of resource: dual-stack
Successful operation
Internal Error
Response Content-Types: application/json
DUAL-STACK - Retrieve
Retrieve operation of resource: dual-stack
TRANSPORT-CONNECTION - Update
Update operation of resource: transport-connection
transport-connectionbody object
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-CONNECTION - Create
Create operation of resource: transport-connection
transport-connectionbody object
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-CONNECTION - Delete
Delete operation of resource: transport-connection
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-CONNECTION - Retrieve
Retrieve operation of resource: transport-connection
Successful operation
Internal Error
PREFER - Update
Update operation of resource: prefer
preferbody object
Request Content-Types: application/json
Request Example
{
"ipv4": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
PREFER - Create
Create operation of resource: prefer
preferbody object
Request Content-Types: application/json
Request Example
{
"ipv4": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
PREFER - Delete
Delete operation of resource: prefer
Successful operation
Internal Error
Response Content-Types: application/json
PREFER - Retrieve
Retrieve operation of resource: prefer
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": [ null ]
}
GRACEFUL-RESTART - Update
Update operation of resource: graceful-restart
graceful-restartbody object
Request Content-Types: application/json
Request Example
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Create
Create operation of resource: graceful-restart
graceful-restartbody object
Request Content-Types: application/json
Request Example
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Delete
Delete operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
HELPER-PEER - Update
Update operation of resource: helper-peer
helper-peerbody object
Request Content-Types: application/json
Request Example
{
"maintain-on-local-reset": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Create
Create operation of resource: helper-peer
helper-peerbody object
Request Content-Types: application/json
Request Example
{
"maintain-on-local-reset": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Delete
Delete operation of resource: helper-peer
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Retrieve
Retrieve operation of resource: helper-peer
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maintain-on-local-reset": "string"
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
AFS - Update
Update operation of resource: afs
afsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
AF - Update
Update operation of resource: af
afbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of interface-name
ID of af-name
Successful operation
Internal Error
TRANSPORT-ADDRESS - Update
Update operation of resource: transport-address
transport-addressbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"address-type": "string",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Create
Create operation of resource: transport-address
transport-addressbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"address-type": "string",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Delete
Delete operation of resource: transport-address
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: transport-address
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address-type": "string",
"address": "string"
}
IGP - Update
Update operation of resource: igp
igpbody object
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Create
Create operation of resource: igp
igpbody object
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Delete
Delete operation of resource: igp
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Retrieve
Retrieve operation of resource: igp
ID of interface-name
ID of af-name
MLDP - Update
Update operation of resource: mldp
mldpbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Create
Create operation of resource: mldp
mldpbody object
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Delete
Delete operation of resource: mldp
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Retrieve
Retrieve operation of resource: mldp
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}
GLOBAL - Update
Update operation of resource: global
globalbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Create
Create operation of resource: global
globalbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Delete
Delete operation of resource: global
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Retrieve
Retrieve operation of resource: global
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of interface-name
Successful operation
Internal Error
LINK-HELLO - Update
Update operation of resource: link-hello
link-hellobody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"hold-time": "string",
"interval": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Create
Create operation of resource: link-hello
link-hellobody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"hold-time": "string",
"interval": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Delete
Delete operation of resource: link-hello
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hold-time": "string",
"interval": "string"
}
IGP - Update
Update operation of resource: igp
igpbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Create
Create operation of resource: igp
igpbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Delete
Delete operation of resource: igp
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Retrieve
Retrieve operation of resource: igp
ID of interface-name
SYNC - Update
Update operation of resource: sync
syncbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Create
Create operation of resource: sync
syncbody object
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Delete
Delete operation of resource: sync
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Retrieve
Retrieve operation of resource: sync
ID of interface-name
Successful operation
Internal Error
DELAY - Update
Update operation of resource: delay
delaybody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer",
"on-session-up": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Create
Create operation of resource: delay
delaybody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer",
"on-session-up": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Delete
Delete operation of resource: delay
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Retrieve
Retrieve operation of resource: delay
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"on-proc-restart": "integer",
"on-session-up": "integer"
}
ON-SESSION-UP - Update
Update operation of resource: on-session-up
on-session-upbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"disable": [ null ],
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-SESSION-UP - Create
Create operation of resource: on-session-up
on-session-upbody object
ID of interface-name
Request Content-Types: application/json
Request Example
{
"disable": [ null ],
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-SESSION-UP - Delete
Delete operation of resource: on-session-up
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-SESSION-UP - Retrieve
Retrieve operation of resource: on-session-up
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"disable": [ null ],
"timeout": "integer"
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
GLOBAL - Update
Update operation of resource: global
globalbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Create
Create operation of resource: global
globalbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Delete
Delete operation of resource: global
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Retrieve
Retrieve operation of resource: global
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
SESSION - Update
Update operation of resource: session
sessionbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
ID of vrf-name
Successful operation
Internal Error
DOWNSTREAM-ON-DEMAND - Update
Update operation of resource: downstream-on-demand
downstream-on-demandbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Create
Create operation of resource: downstream-on-demand
downstream-on-demandbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Delete
Delete operation of resource: downstream-on-demand
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DOWNSTREAM-ON-DEMAND - Retrieve
Retrieve operation of resource: downstream-on-demand
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-acl-name": "string",
"type": "string"
}
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
ID of vrf-name
Successful operation
Internal Error
LDP-IDS - Update
Update operation of resource: ldp-ids
ldp-idsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Create
Create operation of resource: ldp-ids
ldp-idsbody object
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Delete
Delete operation of resource: ldp-ids
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
LDP-IDS - Retrieve
Retrieve operation of resource: ldp-ids
ID of vrf-name
LDP-ID - Update
Update operation of resource: ldp-id
ldp-idbody object
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Create
Create operation of resource: ldp-id
ldp-idbody object
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Delete
Delete operation of resource: ldp-id
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
LDP-ID - Retrieve
Retrieve operation of resource: ldp-id
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
PASSWORD - Update
Update operation of resource: password
passwordbody object
ID of vrf-name
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{
"command-type": "string",
"password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Create
Create operation of resource: password
passwordbody object
ID of vrf-name
ID of lsr-id label-space-id
Request Content-Types: application/json
Request Example
{
"command-type": "string",
"password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Delete
Delete operation of resource: password
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PASSWORD - Retrieve
Retrieve operation of resource: password
ID of vrf-name
ID of lsr-id label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"command-type": "string",
"password": "string"
}
GRACEFUL-RESTART - Update
Update operation of resource: graceful-restart
graceful-restartbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Create
Create operation of resource: graceful-restart
graceful-restartbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Delete
Delete operation of resource: graceful-restart
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
HELPER-PEER - Update
Update operation of resource: helper-peer
helper-peerbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"maintain-on-local-reset": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Create
Create operation of resource: helper-peer
helper-peerbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"maintain-on-local-reset": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Delete
Delete operation of resource: helper-peer
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
HELPER-PEER - Retrieve
Retrieve operation of resource: helper-peer
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maintain-on-local-reset": "string"
}
AFS - Update
Update operation of resource: afs
afsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
AF - Update
Update operation of resource: af
afbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of vrf-name
ID of af-name
Successful operation
Internal Error
LABEL - Update
Update operation of resource: label
labelbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}, { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Create
Create operation of resource: label
labelbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}, { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Delete
Delete operation of resource: label
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
LABEL - Retrieve
Retrieve operation of resource: label
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}, { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
}
}
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of vrf-name
ID of af-name
Successful operation
Internal Error
ACCEPT - Update
Update operation of resource: accept
acceptbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Create
Create operation of resource: accept
acceptbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Delete
Delete operation of resource: accept
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ACCEPT - Retrieve
Retrieve operation of resource: accept
ID of vrf-name
ID of af-name
PEER-ACCEPT-POLICIES - Update
Update operation of resource: peer-accept-policies
peer-accept-policiesbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Create
Create operation of resource: peer-accept-policies
peer-accept-policiesbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Delete
Delete operation of resource: peer-accept-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICIES - Retrieve
Retrieve operation of resource: peer-accept-policies
ID of vrf-name
ID of af-name
PEER-ACCEPT-POLICY - Update
Update operation of resource: peer-accept-policy
peer-accept-policybody object
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Create
Create operation of resource: peer-accept-policy
peer-accept-policybody object
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Delete
Delete operation of resource: peer-accept-policy
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY - Retrieve
Retrieve operation of resource: peer-accept-policy
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
PEER-ACCEPT-POLICY-DATA - Update
Update operation of resource: peer-accept-policy-data
peer-accept-policy-databody object
ID of vrf-name
ID of af-name
ID of label-space-id
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY-DATA - Create
Create operation of resource: peer-accept-policy-data
peer-accept-policy-databody object
ID of vrf-name
ID of af-name
ID of label-space-id
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY-DATA - Delete
Delete operation of resource: peer-accept-policy-data
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ACCEPT-POLICY-DATA - Retrieve
Retrieve operation of resource: peer-accept-policy-data
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
LSR-ID - Update
Update operation of resource: lsr-id
lsr-idbody object
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Request Content-Types: application/json
Request Example
{
"lsr-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Create
Create operation of resource: lsr-id
lsr-idbody object
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Request Content-Types: application/json
Request Example
{
"lsr-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Delete
Delete operation of resource: lsr-id
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Retrieve
Retrieve operation of resource: lsr-id
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsr-id": "string"
}
LOCAL - Update
Update operation of resource: local
localbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Create
Create operation of resource: local
localbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Delete
Delete operation of resource: local
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL - Retrieve
Retrieve operation of resource: local
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string", "prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}
ADVERTISE - Update
Update operation of resource: advertise
advertisebody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Create
Create operation of resource: advertise
advertisebody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Delete
Delete operation of resource: advertise
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ADVERTISE - Retrieve
Retrieve operation of resource: advertise
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
},
"disable": [ null ], { {
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}, "peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
}
PEER-ADVERTISE-POLICIES - Update
Update operation of resource: peer-advertise-policies
peer-advertise-policiesbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Create
Create operation of resource: peer-advertise-policies
peer-advertise-policiesbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Delete
Delete operation of resource: peer-advertise-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICIES - Retrieve
Retrieve operation of resource: peer-advertise-policies
ID of vrf-name
ID of af-name
PEER-ADVERTISE-POLICY - Update
Update operation of resource: peer-advertise-policy
peer-advertise-policybody object
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Create
Create operation of resource: peer-advertise-policy
peer-advertise-policybody object
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Delete
Delete operation of resource: peer-advertise-policy
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY - Retrieve
Retrieve operation of resource: peer-advertise-policy
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
PEER-ADVERTISE-POLICY-DATA - Update
Update operation of resource: peer-advertise-policy-data
peer-advertise-policy-databody object
ID of vrf-name
ID of af-name
ID of label-space-id
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY-DATA - Create
Create operation of resource: peer-advertise-policy-data
peer-advertise-policy-databody object
ID of vrf-name
ID of af-name
ID of label-space-id
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY-DATA - Delete
Delete operation of resource: peer-advertise-policy-data
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
PEER-ADVERTISE-POLICY-DATA - Retrieve
Retrieve operation of resource: peer-advertise-policy-data
ID of vrf-name
ID of af-name
ID of label-space-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
LSR-ID - Update
Update operation of resource: lsr-id
lsr-idbody object
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Request Content-Types: application/json
Request Example
{
"lsr-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Create
Create operation of resource: lsr-id
lsr-idbody object
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Request Content-Types: application/json
Request Example
{
"lsr-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Delete
Delete operation of resource: lsr-id
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
LSR-ID - Retrieve
Retrieve operation of resource: lsr-id
ID of vrf-name
ID of af-name
ID of label-space-id
ID of lsr-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsr-id": "string"
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of vrf-name
ID of af-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of vrf-name
ID of af-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of vrf-name
ID of af-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of vrf-name
ID of af-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
EXPLICIT-NULL - Update
Update operation of resource: explicit-null
explicit-nullbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Create
Create operation of resource: explicit-null
explicit-nullbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Delete
Delete operation of resource: explicit-null
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
EXPLICIT-NULL - Retrieve
Retrieve operation of resource: explicit-null
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
ALLOCATE - Update
Update operation of resource: allocate
allocatebody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"prefix-acl-name": "string",
"allocation-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Create
Create operation of resource: allocate
allocatebody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"prefix-acl-name": "string",
"allocation-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Delete
Delete operation of resource: allocate
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
ALLOCATE - Retrieve
Retrieve operation of resource: allocate
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-acl-name": "string",
"allocation-type": "string"
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ],
"interface-name": "string", {
"af-name": "string",
"enable": [ null ], "address-type": "string",
"address": "string"
}
}
}
]
}
}
AFS - Update
Update operation of resource: afs
afsbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
AF - Update
Update operation of resource: af
afbody object
ID of vrf-name
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of vrf-name
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
TRANSPORT-ADDRESS - Update
Update operation of resource: transport-address
transport-addressbody object
ID of vrf-name
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"address-type": "string",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Create
Create operation of resource: transport-address
transport-addressbody object
ID of vrf-name
ID of interface-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"address-type": "string",
"address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Delete
Delete operation of resource: transport-address
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSPORT-ADDRESS - Retrieve
Retrieve operation of resource: transport-address
ID of vrf-name
ID of interface-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"address-type": "string",
"address": "string"
}
GLOBAL - Update
Update operation of resource: global
globalbody object
Request Content-Types: application/json
Request Example
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Create
Create operation of resource: global
globalbody object
Request Content-Types: application/json
Request Example
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Delete
Delete operation of resource: global
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL - Retrieve
Retrieve operation of resource: global
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "enable": [ null ]
}, "on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}, {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}, "hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ], "hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer", "hold-time": "integer", "max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ], "dscp": "string"
}
}
ENTROPY-LABEL - Update
Update operation of resource: entropy-label
entropy-labelbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ENTROPY-LABEL - Create
Create operation of resource: entropy-label
entropy-labelbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ENTROPY-LABEL - Delete
Delete operation of resource: entropy-label
Successful operation
Internal Error
Response Content-Types: application/json
ENTROPY-LABEL - Retrieve
Retrieve operation of resource: entropy-label
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ]
}
SESSION - Update
Update operation of resource: session
sessionbody object
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Create
Create operation of resource: session
sessionbody object
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Delete
Delete operation of resource: session
Successful operation
Internal Error
Response Content-Types: application/json
SESSION - Retrieve
Retrieve operation of resource: session
Successful operation
Internal Error
BACKOFF-TIME - Update
Update operation of resource: backoff-time
backoff-timebody object
Request Content-Types: application/json
Request Example
{
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BACKOFF-TIME - Create
Create operation of resource: backoff-time
backoff-timebody object
Request Content-Types: application/json
Request Example
{
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BACKOFF-TIME - Delete
Delete operation of resource: backoff-time
Successful operation
Internal Error
Response Content-Types: application/json
BACKOFF-TIME - Retrieve
Retrieve operation of resource: backoff-time
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
IGP - Update
Update operation of resource: igp
igpbody object
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Create
Create operation of resource: igp
igpbody object
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Delete
Delete operation of resource: igp
Successful operation
Internal Error
Response Content-Types: application/json
IGP - Retrieve
Retrieve operation of resource: igp
SYNC - Update
Update operation of resource: sync
syncbody object
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Create
Create operation of resource: sync
syncbody object
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Delete
Delete operation of resource: sync
Successful operation
Internal Error
Response Content-Types: application/json
SYNC - Retrieve
Retrieve operation of resource: sync
Successful operation
Internal Error
DELAY - Update
Update operation of resource: delay
delaybody object
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer",
"on-session-up": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Create
Create operation of resource: delay
delaybody object
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer",
"on-session-up": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Delete
Delete operation of resource: delay
Successful operation
Internal Error
Response Content-Types: application/json
DELAY - Retrieve
Retrieve operation of resource: delay
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"on-proc-restart": "integer",
"on-session-up": "integer"
}
ENABLE-LOGGING - Update
Update operation of resource: enable-logging
enable-loggingbody object
Request Content-Types: application/json
Request Example
{
"nsr": [ null ],
"adjacency": [ null ],
"session-protection": [ null ],
"neighbor-changes": [ null ],
"gr-session-changes": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ENABLE-LOGGING - Create
Create operation of resource: enable-logging
enable-loggingbody object
Request Content-Types: application/json
Request Example
{
"nsr": [ null ],
"adjacency": [ null ],
"session-protection": [ null ],
"neighbor-changes": [ null ],
"gr-session-changes": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ENABLE-LOGGING - Delete
Delete operation of resource: enable-logging
Successful operation
Internal Error
Response Content-Types: application/json
ENABLE-LOGGING - Retrieve
Retrieve operation of resource: enable-logging
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr": [ null ],
"adjacency": [ null ],
"session-protection": [ null ],
"neighbor-changes": [ null ],
"gr-session-changes": [ null ]
}
SIGNALLING - Update
Update operation of resource: signalling
signallingbody object
Request Content-Types: application/json
Request Example
{
"dscp": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALLING - Create
Create operation of resource: signalling
signallingbody object
Request Content-Types: application/json
Request Example
{
"dscp": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALLING - Delete
Delete operation of resource: signalling
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALLING - Retrieve
Retrieve operation of resource: signalling
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dscp": "string"
}
NSR - Update
Update operation of resource: nsr
nsrbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
NSR - Create
Create operation of resource: nsr
nsrbody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
NSR - Delete
Delete operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
NSR - Retrieve
Retrieve operation of resource: nsr
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ]
}
GRACEFUL-RESTART - Update
Update operation of resource: graceful-restart
graceful-restartbody object
Request Content-Types: application/json
Request Example
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Create
Create operation of resource: graceful-restart
graceful-restartbody object
Request Content-Types: application/json
Request Example
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Delete
Delete operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
DISCOVERY - Update
Update operation of resource: discovery
discoverybody object
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Create
Create operation of resource: discovery
discoverybody object
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Delete
Delete operation of resource: discovery
Successful operation
Internal Error
Response Content-Types: application/json
DISCOVERY - Retrieve
Retrieve operation of resource: discovery
Successful operation
Internal Error
LINK-HELLO - Update
Update operation of resource: link-hello
link-hellobody object
Request Content-Types: application/json
Request Example
{
"hold-time": "string",
"interval": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Create
Create operation of resource: link-hello
link-hellobody object
Request Content-Types: application/json
Request Example
{
"hold-time": "string",
"interval": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Delete
Delete operation of resource: link-hello
Successful operation
Internal Error
Response Content-Types: application/json
LINK-HELLO - Retrieve
Retrieve operation of resource: link-hello
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hold-time": "string",
"interval": "string"
}
TARGETED-HELLO - Update
Update operation of resource: targeted-hello
targeted-hellobody object
Request Content-Types: application/json
Request Example
{
"hold-time": "string",
"interval": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO - Create
Create operation of resource: targeted-hello
targeted-hellobody object
Request Content-Types: application/json
Request Example
{
"hold-time": "string",
"interval": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO - Delete
Delete operation of resource: targeted-hello
Successful operation
Internal Error
Response Content-Types: application/json
TARGETED-HELLO - Retrieve
Retrieve operation of resource: targeted-hello
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hold-time": "string",
"interval": "string"
}
MLDP - Update
Update operation of resource: mldp
mldpbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Create
Create operation of resource: mldp
mldpbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Delete
Delete operation of resource: mldp
Successful operation
Internal Error
Response Content-Types: application/json
MLDP - Retrieve
Retrieve operation of resource: mldp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}, "notifications": [ null ]
}
}, {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-name": "string", {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
AFS - Update
Update operation of resource: afs
afsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
AF - Update
Update operation of resource: af
afbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
RECURSIVE-FORWARDING - Update
Update operation of resource: recursive-forwarding
recursive-forwardingbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Create
Create operation of resource: recursive-forwarding
recursive-forwardingbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Delete
Delete operation of resource: recursive-forwarding
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Retrieve
Retrieve operation of resource: recursive-forwarding
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string",
"enable": [ null ]
}
MLDP-RECURSIVE-FEC - Update
Update operation of resource: mldp-recursive-fec
mldp-recursive-fecbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Create
Create operation of resource: mldp-recursive-fec
mldp-recursive-fecbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Delete
Delete operation of resource: mldp-recursive-fec
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Retrieve
Retrieve operation of resource: mldp-recursive-fec
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string",
"enable": [ null ]
}
NEIGHBOR-POLICIES - Update
Update operation of resource: neighbor-policies
neighbor-policiesbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Create
Create operation of resource: neighbor-policies
neighbor-policiesbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Delete
Delete operation of resource: neighbor-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Retrieve
Retrieve operation of resource: neighbor-policies
ID of vrf-name
ID of af-name
Successful operation
Internal Error
NEIGHBOR-POLICY - Update
Update operation of resource: neighbor-policy
neighbor-policybody object
ID of vrf-name
ID of af-name
ID of root-address policy-mode
Request Content-Types: application/json
Request Example
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Create
Create operation of resource: neighbor-policy
neighbor-policybody object
ID of vrf-name
ID of af-name
ID of root-address policy-mode
Request Content-Types: application/json
Request Example
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Delete
Delete operation of resource: neighbor-policy
ID of vrf-name
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Retrieve
Retrieve operation of resource: neighbor-policy
ID of vrf-name
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
MO-FRR - Update
Update operation of resource: mo-frr
mo-frrbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Create
Create operation of resource: mo-frr
mo-frrbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Delete
Delete operation of resource: mo-frr
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Retrieve
Retrieve operation of resource: mo-frr
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string",
"enable": [ null ]
}
MAKE-BEFORE-BREAK - Update
Update operation of resource: make-before-break
make-before-breakbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Create
Create operation of resource: make-before-break
make-before-breakbody object
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Delete
Delete operation of resource: make-before-break
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Retrieve
Retrieve operation of resource: make-before-break
ID of vrf-name
ID of af-name
Successful operation
Internal Error
SIGNALING - Update
Update operation of resource: signaling
signalingbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"forward-delay": "integer",
"delete-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Create
Create operation of resource: signaling
signalingbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"forward-delay": "integer",
"delete-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Delete
Delete operation of resource: signaling
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Retrieve
Retrieve operation of resource: signaling
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forward-delay": "integer",
"delete-delay": "integer"
}
CSC - Update
Update operation of resource: csc
cscbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Create
Create operation of resource: csc
cscbody object
ID of vrf-name
ID of af-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Delete
Delete operation of resource: csc
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Retrieve
Retrieve operation of resource: csc
ID of vrf-name
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ]
}
DEFAULT-VRF - Update
Update operation of resource: default-vrf
default-vrfbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Create
Create operation of resource: default-vrf
default-vrfbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Delete
Delete operation of resource: default-vrf
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
}
AFS - Update
Update operation of resource: afs
afsbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Create
Create operation of resource: afs
afsbody object
Request Content-Types: application/json
Request Example
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Delete
Delete operation of resource: afs
Successful operation
Internal Error
Response Content-Types: application/json
AFS - Retrieve
Retrieve operation of resource: afs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
]
}
AF - Update
Update operation of resource: af
afbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ], {
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}, "policy": "string",
"enable": [ null ]
}, "enable": [ null ]
},
"af-name": "string", "policy": "string", "forward-delay": "integer",
"delete-delay": "integer"
}
}, "policy": "string",
"enable": [ null ]
}, "policy": "string",
"enable": [ null ]
}
}
RECURSIVE-FORWARDING - Update
Update operation of resource: recursive-forwarding
recursive-forwardingbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Create
Create operation of resource: recursive-forwarding
recursive-forwardingbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Delete
Delete operation of resource: recursive-forwarding
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
RECURSIVE-FORWARDING - Retrieve
Retrieve operation of resource: recursive-forwarding
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string",
"enable": [ null ]
}
MLDP-RECURSIVE-FEC - Update
Update operation of resource: mldp-recursive-fec
mldp-recursive-fecbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Create
Create operation of resource: mldp-recursive-fec
mldp-recursive-fecbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Delete
Delete operation of resource: mldp-recursive-fec
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-RECURSIVE-FEC - Retrieve
Retrieve operation of resource: mldp-recursive-fec
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string",
"enable": [ null ]
}
NEIGHBOR-POLICIES - Update
Update operation of resource: neighbor-policies
neighbor-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Create
Create operation of resource: neighbor-policies
neighbor-policiesbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Delete
Delete operation of resource: neighbor-policies
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICIES - Retrieve
Retrieve operation of resource: neighbor-policies
ID of af-name
Successful operation
Internal Error
NEIGHBOR-POLICY - Update
Update operation of resource: neighbor-policy
neighbor-policybody object
ID of af-name
ID of root-address policy-mode
Request Content-Types: application/json
Request Example
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Create
Create operation of resource: neighbor-policy
neighbor-policybody object
ID of af-name
ID of root-address policy-mode
Request Content-Types: application/json
Request Example
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Delete
Delete operation of resource: neighbor-policy
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR-POLICY - Retrieve
Retrieve operation of resource: neighbor-policy
ID of af-name
ID of root-address policy-mode
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
MO-FRR - Update
Update operation of resource: mo-frr
mo-frrbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Create
Create operation of resource: mo-frr
mo-frrbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"policy": "string",
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Delete
Delete operation of resource: mo-frr
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MO-FRR - Retrieve
Retrieve operation of resource: mo-frr
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy": "string",
"enable": [ null ]
}
MAKE-BEFORE-BREAK - Update
Update operation of resource: make-before-break
make-before-breakbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Create
Create operation of resource: make-before-break
make-before-breakbody object
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Delete
Delete operation of resource: make-before-break
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
MAKE-BEFORE-BREAK - Retrieve
Retrieve operation of resource: make-before-break
ID of af-name
Successful operation
Internal Error
SIGNALING - Update
Update operation of resource: signaling
signalingbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"forward-delay": "integer",
"delete-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Create
Create operation of resource: signaling
signalingbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"forward-delay": "integer",
"delete-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Delete
Delete operation of resource: signaling
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
SIGNALING - Retrieve
Retrieve operation of resource: signaling
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forward-delay": "integer",
"delete-delay": "integer"
}
CSC - Update
Update operation of resource: csc
cscbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Create
Create operation of resource: csc
cscbody object
ID of af-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Delete
Delete operation of resource: csc
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
CSC - Retrieve
Retrieve operation of resource: csc
ID of af-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ]
}
MLDP-GLOBAL - Update
Update operation of resource: mldp-global
mldp-globalbody object
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-GLOBAL - Create
Create operation of resource: mldp-global
mldp-globalbody object
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-GLOBAL - Delete
Delete operation of resource: mldp-global
Successful operation
Internal Error
Response Content-Types: application/json
MLDP-GLOBAL - Retrieve
Retrieve operation of resource: mldp-global
Successful operation
Internal Error
LOGGING - Update
Update operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{
"notifications": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{
"notifications": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"notifications": [ null ]
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
VIEWS - Update
Update operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
LOGGING - Update
Update operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
AGENT - Update
Update operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknown-user": [ null ]
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
TARGET - Update
Update operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
TARGETS - Update
Update operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}, "session-up": [ null ],
"session-down": [ null ],
"init-session-threshold-exceeded": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}, "session-up": [ null ],
"session-down": [ null ],
"init-session-threshold-exceeded": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}, "session-up": [ null ],
"session-down": [ null ],
"init-session-threshold-exceeded": [ null ]
}
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
MPLS-LDP - Update
Update operation of resource: mpls-ldp
mpls-ldpbody object
Request Content-Types: application/json
Request Example
{
"session-up": [ null ],
"session-down": [ null ],
"init-session-threshold-exceeded": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Create
Create operation of resource: mpls-ldp
mpls-ldpbody object
Request Content-Types: application/json
Request Example
{
"session-up": [ null ],
"session-down": [ null ],
"init-session-threshold-exceeded": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Delete
Delete operation of resource: mpls-ldp
Successful operation
Internal Error
Response Content-Types: application/json
MPLS-LDP - Retrieve
Retrieve operation of resource: mpls-ldp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-up": [ null ],
"session-down": [ null ],
"init-session-threshold-exceeded": [ null ]
}
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
Successful operation
Internal Error
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rulename": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string"
}
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"drop-time": "integer",
"throttle-rate": "integer"
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
Schema Definitions
ENABLE:
Common node of mldp, vrf
- enable: null
-
Enable Multicast Label Distribution Protocol (mLDP)
Example
{
"enable": [ null ]
}
AF-TABLE:
Common node of default-vrf, vrf
- afs: object
-
Address Family specific operational data
-
- af: object[]
-
Operational data for given Address Family
-
object - mldp-rib-unicast-always: null
-
Enable MPLS MLDP RIB unicast-always configuration
- enable: null
-
Enable Multicast Label Distribution Protocol (mLDP) under AF.
- neighbor-policies: object
-
MLDP neighbor policies
-
- neighbor-policy: object[]
-
Route Policy
-
object - route-policy: string
-
Route policy name
- root-address: string
-
Neighbor Address
- policy-mode: string inbound, outbound
-
Inbound/Outbound Policy
- recursive-forwarding: object
-
Enable recursive forwarding
-
- policy: string
-
Recursive forwarding policy name
- enable: null
-
Enable recursive forwarding
- csc: object
-
MPLS mLDP CSC
-
- enable: null
-
Enable MPLS mLDP CSC
- af-name: string ipv4, ipv6
-
Address Family name
- make-before-break: object
-
MPLS mLDP Make-Before-Break configuration
-
- policy: string
-
Route policy name
- signaling: object
-
Enable MPLS mLDP MBB signaling
-
- forward-delay: integer
-
Forwarding Delay in Seconds
range:"0..600" units:"second" - delete-delay: integer
-
Delete Delay in seconds
range:"0..60" units:"second"
- mldp-recursive-fec: object
-
MPLS mLDP Recursive FEC
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP Recursive FEC
- mo-frr: object
-
MPLS mLDP MoFRR
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP MoFRR
Example
{
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
}
mpls-ldp_schema:
MPLS LDP configuration
- enable: null
-
Enable Label Distribution Protocol (LDP) globally.Without creating this object the LDP feature will not be enabled. Deleting this object will stop the LDP feature.
- global: object
-
Global configuration for MPLS LDP
-
- entropy-label: object
-
Configure for LDP Entropy-Label
-
- enable: null
-
none
- igp: object
-
LDP IGP configuration
-
- sync: object
-
LDP IGP synchronization
-
- delay: object
-
LDP IGP synchronization delay time
-
- on-proc-restart: integer
-
Global sync up delay to be used after process restart
range:"60..600" units:"second" - on-session-up: integer
-
Interface sync up delay after session up
range:"5..300" units:"second"
- mldp:
-
MPLS mLDP configuration
- discovery: object
-
Configure Discovery parameters
-
- targeted-hello: object
-
LDP Targeted Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Targeted Hello interval
- disable-quick-start: null
-
Disable discovery's quick start mode
- link-hello: object
-
LDP Link Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Link Hello interval
- disable-instance-tlv: null
-
Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages
- ltrace-buf-multiplier: integer
-
Configure Ltrace Buffer Multiplier
range:"1..5" default:"1" - session: object
-
LDP Session parameters
-
- hold-time: integer
-
LDP Session holdtime
range:"15..65535" units:"second" default:"180" - backoff-time: object
-
Configure Session Backoff parameters
-
- max-backoff-time: integer
-
Maximum session backoff time (seconds)
range:"5..2147483" units:"second" default:"120" - initial-backoff-time: integer
-
Initial session backoff time (seconds)
range:"5..2147483" units:"second" default:"15"
- disable-implicit-ipv4: null
-
Disable the implicit enabling for IPv4 address family
- signalling: object
-
Configure LDP signalling parameters
-
- dscp: string
-
DSCP for control packets
- enable-logging: object
-
Enable logging of events
-
- nsr: null
-
Enable logging of NSR events
- adjacency: null
-
Enable logging of adjacency events
- session-protection: null
-
Enable logging of session protection events
- neighbor-changes: null
-
Enable logging of neighbor events
- gr-session-changes: null
-
Enable logging of Graceful Restart (GR) events
- nsr: object
-
Configure LDP Non-Stop Routing
-
- enable: null
-
none
- graceful-restart: object
-
Configuration for LDP Graceful Restart parameters
-
- reconnect-timeout: integer
-
Configure Graceful Restart Reconnect Timeout value
range:"60..1800" units:"second" default:"120" - enable: null
-
none
- forwarding-hold-time: integer
-
Configure Graceful Restart Session holdtime
range:"60..1800" units:"second" default:"180"
- default-vrf: object
-
Global VRF attribute configuration for MPLS LDP
-
- interfaces: object
-
MPLS LDP configuration pertaining to interfaces
-
- interface: object[]
-
MPLS LDP configuration for a particular interface
-
object - global: object
-
Per VRF interface Global configuration for MPLS LDP
-
- igp: object
-
LDP IGP configuration
-
- sync: object
-
LDP IGP synchronization
-
- delay: object
-
LDP IGP synchronization delay time
-
- on-session-up: object
-
Interface sync up delay after session up
-
- disable: null
-
Disable delay after session up
- timeout: integer
-
Time (seconds)
range:"1..600000" units:"second"
- discovery: object
-
Configure interface discovery parameters
-
- disable-quick-start: null
-
Disable discovery's quick start mode
- link-hello: object
-
LDP Link Hellos
-
- dual-stack: string ipv4, ipv6
-
Dual Stack Address Family Preference
- interval: string
-
Link Hello interval
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- enable: null
-
Enable Label Distribution Protocol (LDP) on thisinterface
- interface-name: string
-
Name of interface
- afs: object
-
Address Family specific configuration for MPLS LDP intf
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family name
- enable: null
-
Enable Address Family
- mldp: object
-
Interface configuration parameters for mLDP
-
- disable: null
-
Disable mLDP on LDP enabled interface
- discovery: object
-
Configure interface discovery parameters
-
- transport-address: object
-
MPLS LDP configuration for interface discovery transportaddress.
-
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
- igp: object
-
LDP interface IGP configuration
-
- disable-auto-config: null
-
Disable IGP Auto-config on this interface
- global: object
-
Default VRF Global configuration for MPLS LDP
-
- session: object
-
LDP Session parameters
-
- downstream-on-demand: object
-
ACL with the list of neighbors configured for Downstream on Demand
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
Downstream on demand type
- protection: object
-
Configure Session Protection parameters
-
- peer-acl-name: string
-
Name of peer ACL
- protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever
-
Session protection type
- duration: integer
-
Holdup duration
range:"30..2147483"
- router-id: string
-
Configuration for LDP Router ID (LDP ID)
- neighbor: object
-
Configuration related to Neighbors
-
- password: string
-
Default password for all neigbors
- dual-stack: object
-
Configuration related to neighbor transport
-
- tlv-compliance: null
-
Configuration to enable neighbor dual-stack tlv-compliance
- transport-connection: object
-
Configuration related to neighbor transport
-
- max-wait: integer
-
Configuration related to neighbor dual-stack xport-connection max-wait
range:"0..60" units:"second" - prefer: object
-
Configuration related to neighbor dual-stack xport-connection preference
-
- ipv4: null
-
Configuration related to neighbor dual-stack xport-connection preference ipv4
- ldp-ids: object
-
Configuration related to Neighbors using LDP Id
-
- ldp-id: object[]
-
LDP ID based configuration related to a neigbor
-
object - lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
- graceful-restart: object
-
Configuration for per-VRF LDP Graceful Restart parameters
-
- helper-peer: object
-
Configure parameters related to GR peer(s) opearating in helper mode
-
- maintain-on-local-reset: string
-
Maintain the state of a GR peer upon a local reset
- afs: object
-
Address Family specific configuration for MPLS LDP
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family type
- enable: null
-
Enable Address Family
- neighbor: object
-
Configuration related to Neighbors
-
- addresses: object
-
Configuration related to neighbors using neighbor address
-
- address: object[]
-
IP address based configuration related to a neighbor
-
object - targeted: null
-
Establish targeted session with given address
- ip-address: string
-
The IP address
- traffic-engineering: object
-
MPLS Traffic Engingeering parameters for LDP
-
- auto-tunnel-mesh: object
-
MPLS Traffic Engineering auto-tunnel mesh parameters for LDP
-
- group-all: null
-
Enable all MPLS TE auto-tunnel mesh-group interfaces
- group-ids: object
-
Enable interfaces in specific MPLS TE auto-tunnel mesh-groups
-
- group-id: object[]
-
Auto-mesh group identifier to enable
-
object - mesh-group-id: string
-
Mesh group ID
- discovery: object
-
Configure Discovery parameters
-
- transport-address: string
-
Global discovery transport address for address family
- targeted-hello-accept: object
-
Configure acceptance from and responding to targeted hellos.
-
- peer-acl-name: string
-
Name of peer ACL
- accept-type: string all, from
-
Type of acceptance
- redistribution-protocol: object
-
MPLS LDP configuration for protocol redistribution
-
- bgp: object
-
MPLS LDP configuration for protocol redistribution
-
- as: object
-
MPLS LDP configuration for protocol redistribution
-
- as-xx: integer
-
First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.
range:"0..65535" - as-yy: integer
-
Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.
range:"0..4294967295"
- advertise-to: object
-
ACL containing list of neighbors for BGP route redistribution
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
advertise to peer acl type
- label: object
-
Configure Label policies and control
-
- local: object
-
Configure local label policies and control
-
- advertise: object
-
Configure outbound label advertisement
-
- prefix-advertise-policies: object
-
Configure prefix centric outbound label advertisement using ACL
-
- prefix-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - peer-acl-name: string
-
Name of peer ACL
- prefix-acl-name: string
-
Name of prefix ACL
- advertise-type: string for, for-to
-
Label advertise type
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: string
-
LSR ID of neighbor
- prefix-acl-name: string
-
Name of prefix ACL
- label-space-id: integer
-
Label space ID of neighbor
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
- implicit-null-override: string
-
Control use of implicit-null label for set of prefix(es)
- allocate: object
-
Control local label allocation for prefix(es)
-
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
- default-route: null
-
Enable MPLS forwarding for default route
- remote: object
-
Configure remote/peer label policies and control
-
- accept: object
-
Configure inbound label acceptance
-
- peer-accept-policies: object
-
Configuration related to neighbors for inbound label acceptance
-
- peer-accept-policy: object[]
-
Control acceptance of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: string
-
LSR ID of neighbor
- prefix-acl-name: string
-
Name of prefix ACL
- label-space-id: integer
-
Label space ID of neighbor
- vrfs: object
-
VRF Table attribute configuration for MPLS LDP
-
- vrf: object[]
-
VRF attribute configuration for MPLS LDP
-
object - interfaces: object
-
MPLS LDP configuration pertaining to interfaces
-
- interface: object[]
-
MPLS LDP configuration for a particular interface
-
object - enable: null
-
Enable Label Distribution Protocol (LDP) on thisinterface
- interface-name: string
-
Name of interface
- afs: object
-
Address Family specific configuration for MPLS LDP vrf intf
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family name
- enable: null
-
Enable Address Family
- discovery: object
-
Configure interface discovery parameters
-
- transport-address: object
-
MPLS LDP configuration for interface discovery transportaddress.
-
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
- global: object
-
Per VRF Global configuration for MPLS LDP
-
- session: object
-
LDP Session parameters
-
- downstream-on-demand: object
-
ACL with the list of neighbors configured for Downstream on Demand
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
Downstream on demand type
- router-id: string
-
Configuration for LDP Router ID (LDP ID)
- neighbor: object
-
Configuration related to Neighbors
-
- password: string
-
Default password for all neigbors
- ldp-ids: object
-
Configuration related to Neighbors using LDP Id
-
- ldp-id: object[]
-
LDP ID based configuration related to a neigbor
-
object - lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
- graceful-restart: object
-
Configuration for per-VRF LDP Graceful Restart parameters
-
- helper-peer: object
-
Configure parameters related to GR peer(s) opearating in helper mode
-
- maintain-on-local-reset: string
-
Maintain the state of a GR peer upon a local reset
- vrf-name: string
-
VRF Name
- enable: null
-
Enable VRF
- afs: object
-
Address Family specific configuration for MPLS LDP vrf
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family name
- enable: null
-
Enable Address Family
- discovery: object
-
Configure Discovery parameters
-
- transport-address: string
-
Global discovery transport address for address family
- label: object
-
Configure Label policies and control
-
- local: object
-
Configure local label policies and control
-
- advertise: object
-
Configure outbound label advertisement
-
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
- implicit-null-override: string
-
Control use of implicit-null label for set of prefix(es)
- allocate: object
-
Control local label allocation for prefix(es)
-
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
- default-route: null
-
Enable MPLS forwarding for default route
- remote: object
-
Configure remote/peer label policies and control
-
- accept: object
-
Configure inbound label acceptance
-
- peer-accept-policies: object
-
Configuration related to Neighbors for inbound label acceptance
-
- peer-accept-policy: object[]
-
Control acceptasnce of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"enable": [ null ],
"global": {
"entropy-label": {
"enable": [ null ]
},
"igp": {
"sync": {
"delay": {
"on-proc-restart": "integer",
"on-session-up": "integer"
}
}
},
"mldp": {
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
}
]
},
"mldp-global": {
"logging": {
"notifications": [ null ]
}
},
"default-vrf": {
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
},
"discovery": {
"targeted-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ],
"link-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer",
"session": {
"hold-time": "integer",
"backoff-time": {
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ],
"signalling": {}
}
}
default-vrf_schema:
Global VRF attribute configuration for MPLS LDP
- interfaces: object
-
MPLS LDP configuration pertaining to interfaces
-
- interface: object[]
-
MPLS LDP configuration for a particular interface
-
object - global: object
-
Per VRF interface Global configuration for MPLS LDP
-
- igp: object
-
LDP IGP configuration
-
- sync: object
-
LDP IGP synchronization
-
- delay: object
-
LDP IGP synchronization delay time
-
- on-session-up: object
-
Interface sync up delay after session up
-
- disable: null
-
Disable delay after session up
- timeout: integer
-
Time (seconds)
range:"1..600000" units:"second"
- discovery: object
-
Configure interface discovery parameters
-
- disable-quick-start: null
-
Disable discovery's quick start mode
- link-hello: object
-
LDP Link Hellos
-
- dual-stack: string ipv4, ipv6
-
Dual Stack Address Family Preference
- interval: string
-
Link Hello interval
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- enable: null
-
Enable Label Distribution Protocol (LDP) on thisinterface
- interface-name: string
-
Name of interface
- afs: object
-
Address Family specific configuration for MPLS LDP intf
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family name
- enable: null
-
Enable Address Family
- mldp: object
-
Interface configuration parameters for mLDP
-
- disable: null
-
Disable mLDP on LDP enabled interface
- discovery: object
-
Configure interface discovery parameters
-
- transport-address: object
-
MPLS LDP configuration for interface discovery transportaddress.
-
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
- igp: object
-
LDP interface IGP configuration
-
- disable-auto-config: null
-
Disable IGP Auto-config on this interface
- global: object
-
Default VRF Global configuration for MPLS LDP
-
- session: object
-
LDP Session parameters
-
- downstream-on-demand: object
-
ACL with the list of neighbors configured for Downstream on Demand
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
Downstream on demand type
- protection: object
-
Configure Session Protection parameters
-
- peer-acl-name: string
-
Name of peer ACL
- protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever
-
Session protection type
- duration: integer
-
Holdup duration
range:"30..2147483"
- router-id: string
-
Configuration for LDP Router ID (LDP ID)
- neighbor: object
-
Configuration related to Neighbors
-
- password: string
-
Default password for all neigbors
- dual-stack: object
-
Configuration related to neighbor transport
-
- tlv-compliance: null
-
Configuration to enable neighbor dual-stack tlv-compliance
- transport-connection: object
-
Configuration related to neighbor transport
-
- max-wait: integer
-
Configuration related to neighbor dual-stack xport-connection max-wait
range:"0..60" units:"second" - prefer: object
-
Configuration related to neighbor dual-stack xport-connection preference
-
- ipv4: null
-
Configuration related to neighbor dual-stack xport-connection preference ipv4
- ldp-ids: object
-
Configuration related to Neighbors using LDP Id
-
- ldp-id: object[]
-
LDP ID based configuration related to a neigbor
-
object - lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
- graceful-restart: object
-
Configuration for per-VRF LDP Graceful Restart parameters
-
- helper-peer: object
-
Configure parameters related to GR peer(s) opearating in helper mode
-
- maintain-on-local-reset: string
-
Maintain the state of a GR peer upon a local reset
- afs: object
-
Address Family specific configuration for MPLS LDP
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family type
- enable: null
-
Enable Address Family
- neighbor: object
-
Configuration related to Neighbors
-
- addresses: object
-
Configuration related to neighbors using neighbor address
-
- address: object[]
-
IP address based configuration related to a neighbor
-
object - targeted: null
-
Establish targeted session with given address
- ip-address: string
-
The IP address
- traffic-engineering: object
-
MPLS Traffic Engingeering parameters for LDP
-
- auto-tunnel-mesh: object
-
MPLS Traffic Engineering auto-tunnel mesh parameters for LDP
-
- group-all: null
-
Enable all MPLS TE auto-tunnel mesh-group interfaces
- group-ids: object
-
Enable interfaces in specific MPLS TE auto-tunnel mesh-groups
-
- group-id: object[]
-
Auto-mesh group identifier to enable
-
object - mesh-group-id: string
-
Mesh group ID
- discovery: object
-
Configure Discovery parameters
-
- transport-address: string
-
Global discovery transport address for address family
- targeted-hello-accept: object
-
Configure acceptance from and responding to targeted hellos.
-
- peer-acl-name: string
-
Name of peer ACL
- accept-type: string all, from
-
Type of acceptance
- redistribution-protocol: object
-
MPLS LDP configuration for protocol redistribution
-
- bgp: object
-
MPLS LDP configuration for protocol redistribution
-
- as: object
-
MPLS LDP configuration for protocol redistribution
-
- as-xx: integer
-
First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.
range:"0..65535" - as-yy: integer
-
Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.
range:"0..4294967295"
- advertise-to: object
-
ACL containing list of neighbors for BGP route redistribution
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
advertise to peer acl type
- label: object
-
Configure Label policies and control
-
- local: object
-
Configure local label policies and control
-
- advertise: object
-
Configure outbound label advertisement
-
- prefix-advertise-policies: object
-
Configure prefix centric outbound label advertisement using ACL
-
- prefix-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - peer-acl-name: string
-
Name of peer ACL
- prefix-acl-name: string
-
Name of prefix ACL
- advertise-type: string for, for-to
-
Label advertise type
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: string
-
LSR ID of neighbor
- prefix-acl-name: string
-
Name of prefix ACL
- label-space-id: integer
-
Label space ID of neighbor
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
- implicit-null-override: string
-
Control use of implicit-null label for set of prefix(es)
- allocate: object
-
Control local label allocation for prefix(es)
-
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
- default-route: null
-
Enable MPLS forwarding for default route
- remote: object
-
Configure remote/peer label policies and control
-
- accept: object
-
Configure inbound label acceptance
-
- peer-accept-policies: object
-
Configuration related to neighbors for inbound label acceptance
-
- peer-accept-policy: object[]
-
Control acceptance of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: string
-
LSR ID of neighbor
- prefix-acl-name: string
-
Name of prefix ACL
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"interfaces": {
"interface": [
{
"global": {
"igp": {
"sync": {
"delay": {
"on-session-up": {
"disable": [ null ],
"timeout": "integer"
}
}
}
},
"discovery": {
"disable-quick-start": [ null ],
"link-hello": {
"dual-stack": "string",
"interval": "string",
"hold-time": "string"
}
}
},
"enable": [ null ],
"interface-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"enable": [ null ],
"mldp": {
"disable": [ null ]
},
"discovery": {
"transport-address": {
"address-type": "string",
"address": "string"
}
},
"igp": {
"disable-auto-config": [ null ]
}
}
]
}
}
]
},
"global": {
"session": {
"downstream-on-demand": {
"peer-acl-name": "string",
"type": "string"
},
"protection": {
"peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
},
"router-id": "string",
"neighbor": {
"password": "string",
"dual-stack": {
"tlv-compliance": [ null ],
"transport-connection": {
"max-wait": "integer",
"prefer": {
"ipv4": [ null ]
}
}
},
"ldp-ids": {
"ldp-id": [
{
"lsr-id": "string",
"password": {
"command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
]
}
},
"graceful-restart": {
"helper-peer": {
"maintain-on-local-reset": "string"
}
}
},
"afs": {
"af": [
{
"af-name": "string",
"enable": [ null ],
"neighbor": {
"addresses": {
"address": [
{
"targeted": [ null ],
"ip-address": "string"
}
]
}
},
"traffic-engineering": {
"auto-tunnel-mesh": {
"group-all": [ null ],
"group-ids": {
"group-id": [
{
"mesh-group-id": "string"
}
]
}
}
},
"discovery": {
"transport-address": "string",
"targeted-hello-accept": {
"peer-acl-name": "string",
"accept-type": "string"
}
},
"redistribution-protocol": {
"bgp": {
"as": {
"as-xx": "integer",
"as-yy": "integer"
},
"advertise-to": {
"peer-acl-name": "string",
"type": "string"
}
}
},
"label": {
"local": {
"advertise": {
"prefix-advertise-policies": {
"prefix-advertise-policy": [
{
"peer-acl-name": "string",
"prefix-acl-name": "string"
}
]
}
}
}
}
}
]
}
}
afs_schema:
Address Family specific operational data
- af: object[]
-
Operational data for given Address Family
-
object - mldp-rib-unicast-always: null
-
Enable MPLS MLDP RIB unicast-always configuration
- enable: null
-
Enable Multicast Label Distribution Protocol (mLDP) under AF.
- neighbor-policies: object
-
MLDP neighbor policies
-
- neighbor-policy: object[]
-
Route Policy
-
object - route-policy: string
-
Route policy name
- root-address: string
-
Neighbor Address
- policy-mode: string inbound, outbound
-
Inbound/Outbound Policy
- recursive-forwarding: object
-
Enable recursive forwarding
-
- policy: string
-
Recursive forwarding policy name
- enable: null
-
Enable recursive forwarding
- csc: object
-
MPLS mLDP CSC
-
- enable: null
-
Enable MPLS mLDP CSC
- af-name: string ipv4, ipv6
-
Address Family name
- make-before-break: object
-
MPLS mLDP Make-Before-Break configuration
-
- policy: string
-
Route policy name
- signaling: object
-
Enable MPLS mLDP MBB signaling
-
- forward-delay: integer
-
Forwarding Delay in Seconds
range:"0..600" units:"second" - delete-delay: integer
-
Delete Delay in seconds
range:"0..60" units:"second"
- mldp-recursive-fec: object
-
MPLS mLDP Recursive FEC
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP Recursive FEC
- mo-frr: object
-
MPLS mLDP MoFRR
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP MoFRR
Example
{
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
af_schema:
- mldp-rib-unicast-always: null
-
Enable MPLS MLDP RIB unicast-always configuration
- enable: null
-
Enable Multicast Label Distribution Protocol (mLDP) under AF.
- neighbor-policies: object
-
MLDP neighbor policies
-
- neighbor-policy: object[]
-
Route Policy
-
object - route-policy: string
-
Route policy name
- root-address: string
-
Neighbor Address
- policy-mode: string inbound, outbound
-
Inbound/Outbound Policy
- recursive-forwarding: object
-
Enable recursive forwarding
-
- policy: string
-
Recursive forwarding policy name
- enable: null
-
Enable recursive forwarding
- csc: object
-
MPLS mLDP CSC
-
- enable: null
-
Enable MPLS mLDP CSC
- af-name: string ipv4, ipv6
-
Address Family name
- make-before-break: object
-
MPLS mLDP Make-Before-Break configuration
-
- policy: string
-
Route policy name
- signaling: object
-
Enable MPLS mLDP MBB signaling
-
- forward-delay: integer
-
Forwarding Delay in Seconds
range:"0..600" units:"second" - delete-delay: integer
-
Delete Delay in seconds
range:"0..60" units:"second"
- mldp-recursive-fec: object
-
MPLS mLDP Recursive FEC
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP Recursive FEC
- mo-frr: object
-
MPLS mLDP MoFRR
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP MoFRR
Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
label_schema:
Configure Label policies and control
- local: object
-
Configure local label policies and control
-
- advertise: object
-
Configure outbound label advertisement
-
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
- implicit-null-override: string
-
Control use of implicit-null label for set of prefix(es)
- allocate: object
-
Control local label allocation for prefix(es)
-
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
- default-route: null
-
Enable MPLS forwarding for default route
- remote: object
-
Configure remote/peer label policies and control
-
- accept: object
-
Configure inbound label acceptance
-
- peer-accept-policies: object
-
Configuration related to Neighbors for inbound label acceptance
-
- peer-accept-policy: object[]
-
Control acceptasnce of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"local": {
"advertise": {
"interfaces": {
"interface": [
{
"interface-name": "string"
}
]
},
"disable": [ null ],
"peer-advertise-policies": {
"peer-advertise-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
},
"explicit-null": {
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string",
"allocate": {
"prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
},
"remote": {
"accept": {
"peer-accept-policies": {
"peer-accept-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
}
}
remote_schema:
Configure remote/peer label policies and control
- accept: object
-
Configure inbound label acceptance
-
- peer-accept-policies: object
-
Configuration related to Neighbors for inbound label acceptance
-
- peer-accept-policy: object[]
-
Control acceptasnce of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"accept": {
"peer-accept-policies": {
"peer-accept-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
}
accept_schema:
Configure inbound label acceptance
- peer-accept-policies: object
-
Configuration related to Neighbors for inbound label acceptance
-
- peer-accept-policy: object[]
-
Control acceptasnce of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"peer-accept-policies": {
"peer-accept-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
peer-accept-policies_schema:
Configuration related to Neighbors for inbound label acceptance
- peer-accept-policy: object[]
-
Control acceptasnce of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"peer-accept-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
peer-accept-policy_schema:
- lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
local_schema:
Configure local label policies and control
- advertise: object
-
Configure outbound label advertisement
-
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
- implicit-null-override: string
-
Control use of implicit-null label for set of prefix(es)
- allocate: object
-
Control local label allocation for prefix(es)
-
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
- default-route: null
-
Enable MPLS forwarding for default route
Example
{
"advertise": {
"interfaces": {
"interface": [
{
"interface-name": "string"
}
]
},
"disable": [ null ],
"peer-advertise-policies": {
"peer-advertise-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
},
"explicit-null": {
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string",
"allocate": {
"prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}
advertise_schema:
Configure outbound label advertisement
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
Example
{
"interfaces": {
"interface": [
{
"interface-name": "string"
}
]
},
"disable": [ null ],
"peer-advertise-policies": {
"peer-advertise-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
},
"explicit-null": {
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
}
peer-advertise-policies_schema:
Configure peer centric outbound label advertisement using ACL
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"peer-advertise-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
peer-advertise-policy_schema:
- lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
prefix-advertise-policies_schema:
Configure prefix centric outbound label advertisement using ACL
- prefix-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - peer-acl-name: string
-
Name of peer ACL
- prefix-acl-name: string
-
Name of prefix ACL
- advertise-type: string for, for-to
-
Label advertise type
Example
{
"prefix-advertise-policy": [
{
"peer-acl-name": "string",
"prefix-acl-name": "string",
"advertise-type": "string"
}
]
}
prefix-advertise-policy_schema:
- peer-acl-name: string
-
Name of peer ACL
- prefix-acl-name: string
-
Name of prefix ACL
- advertise-type: string for, for-to
-
Label advertise type
Example
{
"peer-acl-name": "string",
"prefix-acl-name": "string",
"advertise-type": "string"
}
explicit-null_schema:
Configure advertisment of explicit-null for connected prefixes.
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
Example
{
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
interfaces_schema:
MPLS LDP configuration pertaining to interfaces
- interface: object[]
-
MPLS LDP configuration for a particular interface
-
object - enable: null
-
Enable Label Distribution Protocol (LDP) on thisinterface
- interface-name: string
-
Name of interface
- afs: object
-
Address Family specific configuration for MPLS LDP vrf intf
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family name
- enable: null
-
Enable Address Family
- discovery: object
-
Configure interface discovery parameters
-
- transport-address: object
-
MPLS LDP configuration for interface discovery transportaddress.
-
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
Example
{
"interface": [
{
"enable": [ null ],
"interface-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"enable": [ null ],
"discovery": {
"transport-address": {
"address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
interface_schema:
- enable: null
-
Enable Label Distribution Protocol (LDP) on thisinterface
- interface-name: string
-
Name of interface
- afs: object
-
Address Family specific configuration for MPLS LDP vrf intf
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family name
- enable: null
-
Enable Address Family
- discovery: object
-
Configure interface discovery parameters
-
- transport-address: object
-
MPLS LDP configuration for interface discovery transportaddress.
-
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
Example
{
"enable": [ null ],
"interface-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"enable": [ null ],
"discovery": {
"transport-address": {
"address-type": "string",
"address": "string"
}
}
}
]
}
}
allocate_schema:
Control local label allocation for prefix(es)
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
Example
{
"prefix-acl-name": "string",
"allocation-type": "string"
}
discovery_schema:
Configure Discovery parameters
- targeted-hello: object
-
LDP Targeted Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Targeted Hello interval
- disable-quick-start: null
-
Disable discovery's quick start mode
- link-hello: object
-
LDP Link Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Link Hello interval
- disable-instance-tlv: null
-
Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages
Example
{
"targeted-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ],
"link-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
}
targeted-hello-accept_schema:
Configure acceptance from and responding to targeted hellos.
- peer-acl-name: string
-
Name of peer ACL
- accept-type: string all, from
-
Type of acceptance
Example
{
"peer-acl-name": "string",
"accept-type": "string"
}
traffic-engineering_schema:
MPLS Traffic Engingeering parameters for LDP
- auto-tunnel-mesh: object
-
MPLS Traffic Engineering auto-tunnel mesh parameters for LDP
-
- group-all: null
-
Enable all MPLS TE auto-tunnel mesh-group interfaces
- group-ids: object
-
Enable interfaces in specific MPLS TE auto-tunnel mesh-groups
-
- group-id: object[]
-
Auto-mesh group identifier to enable
-
object - mesh-group-id: string
-
Mesh group ID
Example
{
"auto-tunnel-mesh": {
"group-all": [ null ],
"group-ids": {
"group-id": [
{
"mesh-group-id": "string"
}
]
}
}
}
auto-tunnel-mesh_schema:
MPLS Traffic Engineering auto-tunnel mesh parameters for LDP
- group-all: null
-
Enable all MPLS TE auto-tunnel mesh-group interfaces
- group-ids: object
-
Enable interfaces in specific MPLS TE auto-tunnel mesh-groups
-
- group-id: object[]
-
Auto-mesh group identifier to enable
-
object - mesh-group-id: string
-
Mesh group ID
Example
{
"group-all": [ null ],
"group-ids": {
"group-id": [
{
"mesh-group-id": "string"
}
]
}
}
group-ids_schema:
Enable interfaces in specific MPLS TE auto-tunnel mesh-groups
- group-id: object[]
-
Auto-mesh group identifier to enable
-
object - mesh-group-id: string
-
Mesh group ID
Example
{
"group-id": [
{
"mesh-group-id": "string"
}
]
}
neighbor_schema:
Configuration related to Neighbors
- password: string
-
Default password for all neigbors
- ldp-ids: object
-
Configuration related to Neighbors using LDP Id
-
- ldp-id: object[]
-
LDP ID based configuration related to a neigbor
-
object - lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"password": "string",
"ldp-ids": {
"ldp-id": [
{
"lsr-id": "string",
"password": {
"command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
]
}
}
addresses_schema:
Configuration related to neighbors using neighbor address
- address: object[]
-
IP address based configuration related to a neighbor
-
object - targeted: null
-
Establish targeted session with given address
- ip-address: string
-
The IP address
Example
{
"address": [
{
"targeted": [ null ],
"ip-address": "string"
}
]
}
address_schema:
- targeted: null
-
Establish targeted session with given address
- ip-address: string
-
The IP address
Example
{
"targeted": [ null ],
"ip-address": "string"
}
redistribution-protocol_schema:
MPLS LDP configuration for protocol redistribution
- bgp: object
-
MPLS LDP configuration for protocol redistribution
-
- as: object
-
MPLS LDP configuration for protocol redistribution
-
- as-xx: integer
-
First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.
range:"0..65535" - as-yy: integer
-
Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.
range:"0..4294967295"
- advertise-to: object
-
ACL containing list of neighbors for BGP route redistribution
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
advertise to peer acl type
Example
{
"bgp": {
"as": {
"as-xx": "integer",
"as-yy": "integer"
},
"advertise-to": {
"peer-acl-name": "string",
"type": "string"
}
}
}
bgp_schema:
MPLS LDP configuration for protocol redistribution
- as: object
-
MPLS LDP configuration for protocol redistribution
-
- as-xx: integer
-
First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.
range:"0..65535" - as-yy: integer
-
Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.
range:"0..4294967295"
- advertise-to: object
-
ACL containing list of neighbors for BGP route redistribution
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
advertise to peer acl type
Example
{
"as": {
"as-xx": "integer",
"as-yy": "integer"
},
"advertise-to": {
"peer-acl-name": "string",
"type": "string"
}
}
as_schema:
MPLS LDP configuration for protocol redistribution
- as-xx: integer
-
First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.
range:"0..65535" - as-yy: integer
-
Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.
range:"0..4294967295"
Example
{
"as-xx": "integer",
"as-yy": "integer"
}
advertise-to_schema:
ACL containing list of neighbors for BGP route redistribution
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
advertise to peer acl type
Example
{
"peer-acl-name": "string",
"type": "string"
}
global_schema:
Global configuration for MPLS LDP
- entropy-label: object
-
Configure for LDP Entropy-Label
-
- enable: null
-
none
- igp: object
-
LDP IGP configuration
-
- sync: object
-
LDP IGP synchronization
-
- delay: object
-
LDP IGP synchronization delay time
-
- on-proc-restart: integer
-
Global sync up delay to be used after process restart
range:"60..600" units:"second" - on-session-up: integer
-
Interface sync up delay after session up
range:"5..300" units:"second"
- mldp:
-
MPLS mLDP configuration
- discovery: object
-
Configure Discovery parameters
-
- targeted-hello: object
-
LDP Targeted Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Targeted Hello interval
- disable-quick-start: null
-
Disable discovery's quick start mode
- link-hello: object
-
LDP Link Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Link Hello interval
- disable-instance-tlv: null
-
Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages
- ltrace-buf-multiplier: integer
-
Configure Ltrace Buffer Multiplier
range:"1..5" default:"1" - session: object
-
LDP Session parameters
-
- hold-time: integer
-
LDP Session holdtime
range:"15..65535" units:"second" default:"180" - backoff-time: object
-
Configure Session Backoff parameters
-
- max-backoff-time: integer
-
Maximum session backoff time (seconds)
range:"5..2147483" units:"second" default:"120" - initial-backoff-time: integer
-
Initial session backoff time (seconds)
range:"5..2147483" units:"second" default:"15"
- disable-implicit-ipv4: null
-
Disable the implicit enabling for IPv4 address family
- signalling: object
-
Configure LDP signalling parameters
-
- dscp: string
-
DSCP for control packets
- enable-logging: object
-
Enable logging of events
-
- nsr: null
-
Enable logging of NSR events
- adjacency: null
-
Enable logging of adjacency events
- session-protection: null
-
Enable logging of session protection events
- neighbor-changes: null
-
Enable logging of neighbor events
- gr-session-changes: null
-
Enable logging of Graceful Restart (GR) events
- nsr: object
-
Configure LDP Non-Stop Routing
-
- enable: null
-
none
- graceful-restart: object
-
Configuration for LDP Graceful Restart parameters
-
- reconnect-timeout: integer
-
Configure Graceful Restart Reconnect Timeout value
range:"60..1800" units:"second" default:"120" - enable: null
-
none
- forwarding-hold-time: integer
-
Configure Graceful Restart Session holdtime
range:"60..1800" units:"second" default:"180"
Example
{
"entropy-label": {
"enable": [ null ]
},
"igp": {
"sync": {
"delay": {
"on-proc-restart": "integer",
"on-session-up": "integer"
}
}
},
"mldp": {
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
}
]
},
"mldp-global": {
"logging": {
"notifications": [ null ]
}
},
"default-vrf": {
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
},
"discovery": {
"targeted-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ],
"link-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer",
"session": {
"hold-time": "integer",
"backoff-time": {
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ],
"signalling": {
"dscp": "string"
},
"enable-logging": {}
}
session_schema:
LDP Session parameters
- hold-time: integer
-
LDP Session holdtime
range:"15..65535" units:"second" default:"180" - backoff-time: object
-
Configure Session Backoff parameters
-
- max-backoff-time: integer
-
Maximum session backoff time (seconds)
range:"5..2147483" units:"second" default:"120" - initial-backoff-time: integer
-
Initial session backoff time (seconds)
range:"5..2147483" units:"second" default:"15"
Example
{
"hold-time": "integer",
"backoff-time": {
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
}
protection_schema:
Configure Session Protection parameters
- peer-acl-name: string
-
Name of peer ACL
- protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever
-
Session protection type
- duration: integer
-
Holdup duration
range:"30..2147483"
Example
{
"peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
downstream-on-demand_schema:
ACL with the list of neighbors configured for Downstream on Demand
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
Downstream on demand type
Example
{
"peer-acl-name": "string",
"type": "string"
}
ldp-ids_schema:
Configuration related to Neighbors using LDP Id
- ldp-id: object[]
-
LDP ID based configuration related to a neigbor
-
object - lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"ldp-id": [
{
"lsr-id": "string",
"password": {
"command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
]
}
ldp-id_schema:
- lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"lsr-id": "string",
"password": {
"command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
password_schema:
Password for MD5 authentication for this neighbor
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
Example
{
"command-type": "string",
"password": "string"
}
dual-stack_schema:
Configuration related to neighbor transport
- tlv-compliance: null
-
Configuration to enable neighbor dual-stack tlv-compliance
- transport-connection: object
-
Configuration related to neighbor transport
-
- max-wait: integer
-
Configuration related to neighbor dual-stack xport-connection max-wait
range:"0..60" units:"second" - prefer: object
-
Configuration related to neighbor dual-stack xport-connection preference
-
- ipv4: null
-
Configuration related to neighbor dual-stack xport-connection preference ipv4
Example
{
"tlv-compliance": [ null ],
"transport-connection": {
"max-wait": "integer",
"prefer": {
"ipv4": [ null ]
}
}
}
transport-connection_schema:
Configuration related to neighbor transport
- max-wait: integer
-
Configuration related to neighbor dual-stack xport-connection max-wait
range:"0..60" units:"second" - prefer: object
-
Configuration related to neighbor dual-stack xport-connection preference
-
- ipv4: null
-
Configuration related to neighbor dual-stack xport-connection preference ipv4
Example
{
"max-wait": "integer",
"prefer": {
"ipv4": [ null ]
}
}
prefer_schema:
Configuration related to neighbor dual-stack xport-connection preference
- ipv4: null
-
Configuration related to neighbor dual-stack xport-connection preference ipv4
Example
{
"ipv4": [ null ]
}
graceful-restart_schema:
Configuration for LDP Graceful Restart parameters
- reconnect-timeout: integer
-
Configure Graceful Restart Reconnect Timeout value
range:"60..1800" units:"second" default:"120" - enable: null
-
none
- forwarding-hold-time: integer
-
Configure Graceful Restart Session holdtime
range:"60..1800" units:"second" default:"180"
Example
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
helper-peer_schema:
Configure parameters related to GR peer(s) opearating in helper mode
- maintain-on-local-reset: string
-
Maintain the state of a GR peer upon a local reset
Example
{
"maintain-on-local-reset": "string"
}
transport-address_schema:
MPLS LDP configuration for interface discovery transportaddress.
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
Example
{
"address-type": "string",
"address": "string"
}
igp_schema:
LDP IGP configuration
- sync: object
-
LDP IGP synchronization
-
- delay: object
-
LDP IGP synchronization delay time
-
- on-proc-restart: integer
-
Global sync up delay to be used after process restart
range:"60..600" units:"second" - on-session-up: integer
-
Interface sync up delay after session up
range:"5..300" units:"second"
Example
{
"sync": {
"delay": {
"on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}
mldp_schema:
MPLS mLDP configuration
- vrfs: object
-
VRF Table attribute configuration for MPLS LDP
-
- vrf: object[]
-
VRF attribute configuration for MPLS LDP
-
- vrf-name: string
-
VRF Name
- mldp-global: object
-
Global configuration for mLDP
-
- logging: object
-
MPLS mLDP logging
-
- notifications: null
-
MPLS mLDP logging notifications
- default-vrf: AF-TABLE
-
Default VRF attribute configuration for mLDP
Example
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
}
]
},
"mldp-global": {
"logging": {
"notifications": [ null ]
}
},
"default-vrf": {
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}
link-hello_schema:
LDP Link Hellos
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Link Hello interval
Example
{
"hold-time": "string",
"interval": "string"
}
sync_schema:
LDP IGP synchronization
- delay: object
-
LDP IGP synchronization delay time
-
- on-proc-restart: integer
-
Global sync up delay to be used after process restart
range:"60..600" units:"second" - on-session-up: integer
-
Interface sync up delay after session up
range:"5..300" units:"second"
Example
{
"delay": {
"on-proc-restart": "integer",
"on-session-up": "integer"
}
}
delay_schema:
LDP IGP synchronization delay time
- on-proc-restart: integer
-
Global sync up delay to be used after process restart
range:"60..600" units:"second" - on-session-up: integer
-
Interface sync up delay after session up
range:"5..300" units:"second"
Example
{
"on-proc-restart": "integer",
"on-session-up": "integer"
}
on-session-up_schema:
Interface sync up delay after session up
- disable: null
-
Disable delay after session up
- timeout: integer
-
Time (seconds)
range:"1..600000" units:"second"
Example
{
"disable": [ null ],
"timeout": "integer"
}
vrfs_schema:
VRF Table attribute configuration for MPLS LDP
- vrf: object[]
-
VRF attribute configuration for MPLS LDP
-
- vrf-name: string
-
VRF Name
Example
{
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
}
]
}
vrf_schema:
- vrf-name: string
-
VRF Name
Example
{
"vrf-name": "string",
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
}
entropy-label_schema:
Configure for LDP Entropy-Label
- enable: null
-
none
Example
{
"enable": [ null ]
}
backoff-time_schema:
Configure Session Backoff parameters
- max-backoff-time: integer
-
Maximum session backoff time (seconds)
range:"5..2147483" units:"second" default:"120" - initial-backoff-time: integer
-
Initial session backoff time (seconds)
range:"5..2147483" units:"second" default:"15"
Example
{
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
enable-logging_schema:
Enable logging of events
- nsr: null
-
Enable logging of NSR events
- adjacency: null
-
Enable logging of adjacency events
- session-protection: null
-
Enable logging of session protection events
- neighbor-changes: null
-
Enable logging of neighbor events
- gr-session-changes: null
-
Enable logging of Graceful Restart (GR) events
Example
{
"nsr": [ null ],
"adjacency": [ null ],
"session-protection": [ null ],
"neighbor-changes": [ null ],
"gr-session-changes": [ null ]
}
signalling_schema:
Configure LDP signalling parameters
- dscp: string
-
DSCP for control packets
Example
{
"dscp": "string"
}
targeted-hello_schema:
LDP Targeted Hellos
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Targeted Hello interval
Example
{
"hold-time": "string",
"interval": "string"
}
recursive-forwarding_schema:
Enable recursive forwarding
- policy: string
-
Recursive forwarding policy name
- enable: null
-
Enable recursive forwarding
Example
{
"policy": "string",
"enable": [ null ]
}
mldp-recursive-fec_schema:
MPLS mLDP Recursive FEC
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP Recursive FEC
Example
{
"policy": "string",
"enable": [ null ]
}
neighbor-policies_schema:
MLDP neighbor policies
- neighbor-policy: object[]
-
Route Policy
-
object - route-policy: string
-
Route policy name
- root-address: string
-
Neighbor Address
- policy-mode: string inbound, outbound
-
Inbound/Outbound Policy
Example
{
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}
neighbor-policy_schema:
- route-policy: string
-
Route policy name
- root-address: string
-
Neighbor Address
- policy-mode: string inbound, outbound
-
Inbound/Outbound Policy
Example
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
mo-frr_schema:
MPLS mLDP MoFRR
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP MoFRR
Example
{
"policy": "string",
"enable": [ null ]
}
make-before-break_schema:
MPLS mLDP Make-Before-Break configuration
- policy: string
-
Route policy name
- signaling: object
-
Enable MPLS mLDP MBB signaling
-
- forward-delay: integer
-
Forwarding Delay in Seconds
range:"0..600" units:"second" - delete-delay: integer
-
Delete Delay in seconds
range:"0..60" units:"second"
Example
{
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
}
signaling_schema:
Enable MPLS mLDP MBB signaling
- forward-delay: integer
-
Forwarding Delay in Seconds
range:"0..600" units:"second" - delete-delay: integer
-
Delete Delay in seconds
range:"0..60" units:"second"
Example
{
"forward-delay": "integer",
"delete-delay": "integer"
}
mldp-global_schema:
Global configuration for mLDP
- logging: object
-
MPLS mLDP logging
-
- notifications: null
-
MPLS mLDP logging notifications
Example
{
"logging": {
"notifications": [ null ]
}
}
logging_schema:
MPLS mLDP logging
- notifications: null
-
MPLS mLDP logging notifications
Example
{
"notifications": [ null ]
}
a1_mpls-ldp_schema:
MPLS-LDP-STD-MIB notification configuration
- session-up: null
-
Enable mplsLdpSessionUp notification
- session-down: null
-
Enable mplsLdpSessionDown notification
- init-session-threshold-exceeded: null
-
Enable mplsLdpInitSessionThresholdExceeded notification
Example
{
"session-up": [ null ],
"session-down": [ null ],
"init-session-threshold-exceeded": [ null ]
}
a1_default-vrf_schema:
Global VRF attribute configuration for MPLS LDP
- interfaces: object
-
MPLS LDP configuration pertaining to interfaces
-
- interface: object[]
-
MPLS LDP configuration for a particular interface
-
object - global: object
-
Per VRF interface Global configuration for MPLS LDP
-
- igp: object
-
LDP IGP configuration
-
- sync: object
-
LDP IGP synchronization
-
- delay: object
-
LDP IGP synchronization delay time
-
- on-session-up: object
-
Interface sync up delay after session up
-
- disable: null
-
Disable delay after session up
- timeout: integer
-
Time (seconds)
range:"1..600000" units:"second"
- discovery: object
-
Configure interface discovery parameters
-
- disable-quick-start: null
-
Disable discovery's quick start mode
- link-hello: object
-
LDP Link Hellos
-
- dual-stack: string ipv4, ipv6
-
Dual Stack Address Family Preference
- interval: string
-
Link Hello interval
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- enable: null
-
Enable Label Distribution Protocol (LDP) on thisinterface
- interface-name: string
-
Name of interface
- afs: object
-
Address Family specific configuration for MPLS LDP intf
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family name
- enable: null
-
Enable Address Family
- mldp: object
-
Interface configuration parameters for mLDP
-
- disable: null
-
Disable mLDP on LDP enabled interface
- discovery: object
-
Configure interface discovery parameters
-
- transport-address: object
-
MPLS LDP configuration for interface discovery transportaddress.
-
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
- igp: object
-
LDP interface IGP configuration
-
- disable-auto-config: null
-
Disable IGP Auto-config on this interface
- global: object
-
Default VRF Global configuration for MPLS LDP
-
- session: object
-
LDP Session parameters
-
- downstream-on-demand: object
-
ACL with the list of neighbors configured for Downstream on Demand
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
Downstream on demand type
- protection: object
-
Configure Session Protection parameters
-
- peer-acl-name: string
-
Name of peer ACL
- protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever
-
Session protection type
- duration: integer
-
Holdup duration
range:"30..2147483"
- router-id: string
-
Configuration for LDP Router ID (LDP ID)
- neighbor: object
-
Configuration related to Neighbors
-
- password: string
-
Default password for all neigbors
- dual-stack: object
-
Configuration related to neighbor transport
-
- tlv-compliance: null
-
Configuration to enable neighbor dual-stack tlv-compliance
- transport-connection: object
-
Configuration related to neighbor transport
-
- max-wait: integer
-
Configuration related to neighbor dual-stack xport-connection max-wait
range:"0..60" units:"second" - prefer: object
-
Configuration related to neighbor dual-stack xport-connection preference
-
- ipv4: null
-
Configuration related to neighbor dual-stack xport-connection preference ipv4
- ldp-ids: object
-
Configuration related to Neighbors using LDP Id
-
- ldp-id: object[]
-
LDP ID based configuration related to a neigbor
-
object - lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
- graceful-restart: object
-
Configuration for per-VRF LDP Graceful Restart parameters
-
- helper-peer: object
-
Configure parameters related to GR peer(s) opearating in helper mode
-
- maintain-on-local-reset: string
-
Maintain the state of a GR peer upon a local reset
- afs: object
-
Address Family specific configuration for MPLS LDP
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family type
- enable: null
-
Enable Address Family
- neighbor: object
-
Configuration related to Neighbors
-
- addresses: object
-
Configuration related to neighbors using neighbor address
-
- address: object[]
-
IP address based configuration related to a neighbor
-
object - targeted: null
-
Establish targeted session with given address
- ip-address: string
-
The IP address
- traffic-engineering: object
-
MPLS Traffic Engingeering parameters for LDP
-
- auto-tunnel-mesh: object
-
MPLS Traffic Engineering auto-tunnel mesh parameters for LDP
-
- group-all: null
-
Enable all MPLS TE auto-tunnel mesh-group interfaces
- group-ids: object
-
Enable interfaces in specific MPLS TE auto-tunnel mesh-groups
-
- group-id: object[]
-
Auto-mesh group identifier to enable
-
object - mesh-group-id: string
-
Mesh group ID
- discovery: object
-
Configure Discovery parameters
-
- transport-address: string
-
Global discovery transport address for address family
- targeted-hello-accept: object
-
Configure acceptance from and responding to targeted hellos.
-
- peer-acl-name: string
-
Name of peer ACL
- accept-type: string all, from
-
Type of acceptance
- redistribution-protocol: object
-
MPLS LDP configuration for protocol redistribution
-
- bgp: object
-
MPLS LDP configuration for protocol redistribution
-
- as: object
-
MPLS LDP configuration for protocol redistribution
-
- as-xx: integer
-
First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.
range:"0..65535" - as-yy: integer
-
Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.
range:"0..4294967295"
- advertise-to: object
-
ACL containing list of neighbors for BGP route redistribution
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
advertise to peer acl type
- label: object
-
Configure Label policies and control
-
- local: object
-
Configure local label policies and control
-
- advertise: object
-
Configure outbound label advertisement
-
- prefix-advertise-policies: object
-
Configure prefix centric outbound label advertisement using ACL
-
- prefix-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - peer-acl-name: string
-
Name of peer ACL
- prefix-acl-name: string
-
Name of prefix ACL
- advertise-type: string for, for-to
-
Label advertise type
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: string
-
LSR ID of neighbor
- prefix-acl-name: string
-
Name of prefix ACL
- label-space-id: integer
-
Label space ID of neighbor
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
- implicit-null-override: string
-
Control use of implicit-null label for set of prefix(es)
- allocate: object
-
Control local label allocation for prefix(es)
-
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
- default-route: null
-
Enable MPLS forwarding for default route
- remote: object
-
Configure remote/peer label policies and control
-
- accept: object
-
Configure inbound label acceptance
-
- peer-accept-policies: object
-
Configuration related to neighbors for inbound label acceptance
-
- peer-accept-policy: object[]
-
Control acceptance of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: string
-
LSR ID of neighbor
- prefix-acl-name: string
-
Name of prefix ACL
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"interfaces": {
"interface": [
{
"global": {
"igp": {
"sync": {
"delay": {
"on-session-up": {
"disable": [ null ],
"timeout": "integer"
}
}
}
},
"discovery": {
"disable-quick-start": [ null ],
"link-hello": {
"dual-stack": "string",
"interval": "string",
"hold-time": "string"
}
}
},
"enable": [ null ],
"interface-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"enable": [ null ],
"mldp": {
"disable": [ null ]
},
"discovery": {
"transport-address": {
"address-type": "string",
"address": "string"
}
},
"igp": {
"disable-auto-config": [ null ]
}
}
]
}
}
]
},
"global": {
"session": {
"downstream-on-demand": {
"peer-acl-name": "string",
"type": "string"
},
"protection": {
"peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
},
"router-id": "string",
"neighbor": {
"password": "string",
"dual-stack": {
"tlv-compliance": [ null ],
"transport-connection": {
"max-wait": "integer",
"prefer": {
"ipv4": [ null ]
}
}
},
"ldp-ids": {
"ldp-id": [
{
"lsr-id": "string",
"password": {
"command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
]
}
},
"graceful-restart": {
"helper-peer": {
"maintain-on-local-reset": "string"
}
}
},
"afs": {
"af": [
{
"af-name": "string",
"enable": [ null ],
"neighbor": {
"addresses": {
"address": [
{
"targeted": [ null ],
"ip-address": "string"
}
]
}
},
"traffic-engineering": {
"auto-tunnel-mesh": {
"group-all": [ null ],
"group-ids": {
"group-id": [
{
"mesh-group-id": "string"
}
]
}
}
},
"discovery": {
"transport-address": "string",
"targeted-hello-accept": {
"peer-acl-name": "string",
"accept-type": "string"
}
},
"redistribution-protocol": {
"bgp": {
"as": {
"as-xx": "integer",
"as-yy": "integer"
},
"advertise-to": {
"peer-acl-name": "string",
"type": "string"
}
}
},
"label": {
"local": {
"advertise": {
"prefix-advertise-policies": {
"prefix-advertise-policy": [
{
"peer-acl-name": "string",
"prefix-acl-name": "string"
}
]
}
}
}
}
}
]
}
}
a1_afs_schema:
Address Family specific operational data
- af: object[]
-
Operational data for given Address Family
-
object - mldp-rib-unicast-always: null
-
Enable MPLS MLDP RIB unicast-always configuration
- enable: null
-
Enable Multicast Label Distribution Protocol (mLDP) under AF.
- neighbor-policies: object
-
MLDP neighbor policies
-
- neighbor-policy: object[]
-
Route Policy
-
object - route-policy: string
-
Route policy name
- root-address: string
-
Neighbor Address
- policy-mode: string inbound, outbound
-
Inbound/Outbound Policy
- recursive-forwarding: object
-
Enable recursive forwarding
-
- policy: string
-
Recursive forwarding policy name
- enable: null
-
Enable recursive forwarding
- csc: object
-
MPLS mLDP CSC
-
- enable: null
-
Enable MPLS mLDP CSC
- af-name: string ipv4, ipv6
-
Address Family name
- make-before-break: object
-
MPLS mLDP Make-Before-Break configuration
-
- policy: string
-
Route policy name
- signaling: object
-
Enable MPLS mLDP MBB signaling
-
- forward-delay: integer
-
Forwarding Delay in Seconds
range:"0..600" units:"second" - delete-delay: integer
-
Delete Delay in seconds
range:"0..60" units:"second"
- mldp-recursive-fec: object
-
MPLS mLDP Recursive FEC
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP Recursive FEC
- mo-frr: object
-
MPLS mLDP MoFRR
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP MoFRR
Example
{
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
a1_af_schema:
- mldp-rib-unicast-always: null
-
Enable MPLS MLDP RIB unicast-always configuration
- enable: null
-
Enable Multicast Label Distribution Protocol (mLDP) under AF.
- neighbor-policies: object
-
MLDP neighbor policies
-
- neighbor-policy: object[]
-
Route Policy
-
object - route-policy: string
-
Route policy name
- root-address: string
-
Neighbor Address
- policy-mode: string inbound, outbound
-
Inbound/Outbound Policy
- recursive-forwarding: object
-
Enable recursive forwarding
-
- policy: string
-
Recursive forwarding policy name
- enable: null
-
Enable recursive forwarding
- csc: object
-
MPLS mLDP CSC
-
- enable: null
-
Enable MPLS mLDP CSC
- af-name: string ipv4, ipv6
-
Address Family name
- make-before-break: object
-
MPLS mLDP Make-Before-Break configuration
-
- policy: string
-
Route policy name
- signaling: object
-
Enable MPLS mLDP MBB signaling
-
- forward-delay: integer
-
Forwarding Delay in Seconds
range:"0..600" units:"second" - delete-delay: integer
-
Delete Delay in seconds
range:"0..60" units:"second"
- mldp-recursive-fec: object
-
MPLS mLDP Recursive FEC
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP Recursive FEC
- mo-frr: object
-
MPLS mLDP MoFRR
-
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP MoFRR
Example
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
a1_label_schema:
Configure Label policies and control
- local: object
-
Configure local label policies and control
-
- advertise: object
-
Configure outbound label advertisement
-
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
- implicit-null-override: string
-
Control use of implicit-null label for set of prefix(es)
- allocate: object
-
Control local label allocation for prefix(es)
-
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
- default-route: null
-
Enable MPLS forwarding for default route
- remote: object
-
Configure remote/peer label policies and control
-
- accept: object
-
Configure inbound label acceptance
-
- peer-accept-policies: object
-
Configuration related to Neighbors for inbound label acceptance
-
- peer-accept-policy: object[]
-
Control acceptasnce of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"local": {
"advertise": {
"interfaces": {
"interface": [
{
"interface-name": "string"
}
]
},
"disable": [ null ],
"peer-advertise-policies": {
"peer-advertise-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
},
"explicit-null": {
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string",
"allocate": {
"prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
},
"remote": {
"accept": {
"peer-accept-policies": {
"peer-accept-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
}
}
a1_remote_schema:
- remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
a1_accept_schema:
Configure inbound label acceptance
- peer-accept-policies: object
-
Configuration related to Neighbors for inbound label acceptance
-
- peer-accept-policy: object[]
-
Control acceptasnce of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"peer-accept-policies": {
"peer-accept-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
}
a1_peer-accept-policies_schema:
Configuration related to Neighbors for inbound label acceptance
- peer-accept-policy: object[]
-
Control acceptasnce of labels from a neighbor for prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"peer-accept-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
a1_peer-accept-policy_schema:
- lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-accept-policy-data: PEER-ACCEPT-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
a1_local_schema:
Configure local label policies and control
- advertise: object
-
Configure outbound label advertisement
-
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
- implicit-null-override: string
-
Control use of implicit-null label for set of prefix(es)
- allocate: object
-
Control local label allocation for prefix(es)
-
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
- default-route: null
-
Enable MPLS forwarding for default route
Example
{
"advertise": {
"interfaces": {
"interface": [
{
"interface-name": "string"
}
]
},
"disable": [ null ],
"peer-advertise-policies": {
"peer-advertise-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
},
"explicit-null": {
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
},
"implicit-null-override": "string",
"allocate": {
"prefix-acl-name": "string",
"allocation-type": "string"
},
"default-route": [ null ]
}
a1_advertise_schema:
Configure outbound label advertisement
- interfaces: object
-
Configure outbound label advertisement for an interface
-
- interface: object[]
-
Control advertisement of interface's host IP address
-
object - interface-name: string
-
Name of interface
- disable: null
-
Disable label advertisement
- peer-advertise-policies: object
-
Configure peer centric outbound label advertisement using ACL
-
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
- explicit-null: object
-
Configure advertisment of explicit-null for connected prefixes.
-
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
Example
{
"interfaces": {
"interface": [
{
"interface-name": "string"
}
]
},
"disable": [ null ],
"peer-advertise-policies": {
"peer-advertise-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
},
"explicit-null": {
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
}
a1_peer-advertise-policies_schema:
Configure peer centric outbound label advertisement using ACL
- peer-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"peer-advertise-policy": [
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
]
}
a1_peer-advertise-policy_schema:
- lsr-id: object[]
-
keys: lsr-id
-
- lsr-id: string
-
LSR ID of neighbor
- peer-advertise-policy-data: PEER-ADVERTISE-POLICY-CONTENT
-
Data container.
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"lsr-id": [
{
"lsr-id": "string"
}
],
"label-space-id": "integer"
}
a1_prefix-advertise-policies_schema:
Configure prefix centric outbound label advertisement using ACL
- prefix-advertise-policy: object[]
-
Control advertisement of prefix(es) using ACL
-
object - peer-acl-name: string
-
Name of peer ACL
- prefix-acl-name: string
-
Name of prefix ACL
- advertise-type: string for, for-to
-
Label advertise type
Example
{
"prefix-advertise-policy": [
{
"peer-acl-name": "string",
"prefix-acl-name": "string",
"advertise-type": "string"
}
]
}
a1_prefix-advertise-policy_schema:
- peer-acl-name: string
-
Name of peer ACL
- prefix-acl-name: string
-
Name of prefix ACL
- advertise-type: string for, for-to
-
Label advertise type
Example
{
"peer-acl-name": "string",
"prefix-acl-name": "string",
"advertise-type": "string"
}
a1_explicit-null_schema:
Configure advertisment of explicit-null for connected prefixes.
- peer-acl-name: string
-
Name of peer ACL
- explicit-null-type: string all, for, to, for-to
-
Explicit Null command variant
- prefix-acl-name: string
-
Name of prefix ACL
Example
{
"peer-acl-name": "string",
"explicit-null-type": "string",
"prefix-acl-name": "string"
}
a1_interfaces_schema:
MPLS LDP configuration pertaining to interfaces
- interface: object[]
-
MPLS LDP configuration for a particular interface
-
object - enable: null
-
Enable Label Distribution Protocol (LDP) on thisinterface
- interface-name: string
-
Name of interface
- afs: object
-
Address Family specific configuration for MPLS LDP vrf intf
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family name
- enable: null
-
Enable Address Family
- discovery: object
-
Configure interface discovery parameters
-
- transport-address: object
-
MPLS LDP configuration for interface discovery transportaddress.
-
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
Example
{
"interface": [
{
"enable": [ null ],
"interface-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"enable": [ null ],
"discovery": {
"transport-address": {
"address-type": "string",
"address": "string"
}
}
}
]
}
}
]
}
a1_interface_schema:
- enable: null
-
Enable Label Distribution Protocol (LDP) on thisinterface
- interface-name: string
-
Name of interface
- afs: object
-
Address Family specific configuration for MPLS LDP vrf intf
-
- af: object[]
-
Configure data for given Address Family
-
object - af-name: string ipv4, ipv6
-
Address Family name
- enable: null
-
Enable Address Family
- discovery: object
-
Configure interface discovery parameters
-
- transport-address: object
-
MPLS LDP configuration for interface discovery transportaddress.
-
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
Example
{
"enable": [ null ],
"interface-name": "string",
"afs": {
"af": [
{
"af-name": "string",
"enable": [ null ],
"discovery": {
"transport-address": {
"address-type": "string",
"address": "string"
}
}
}
]
}
}
a1_allocate_schema:
Control local label allocation for prefix(es)
- prefix-acl-name: string
-
Name of prefix ACL
- allocation-type: string acl, host
-
Label allocation type
Example
{
"prefix-acl-name": "string",
"allocation-type": "string"
}
a1_discovery_schema:
Configure Discovery parameters
- targeted-hello: object
-
LDP Targeted Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Targeted Hello interval
- disable-quick-start: null
-
Disable discovery's quick start mode
- link-hello: object
-
LDP Link Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Link Hello interval
- disable-instance-tlv: null
-
Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages
Example
{
"targeted-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ],
"link-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
}
a1_targeted-hello-accept_schema:
Configure acceptance from and responding to targeted hellos.
- peer-acl-name: string
-
Name of peer ACL
- accept-type: string all, from
-
Type of acceptance
Example
{
"peer-acl-name": "string",
"accept-type": "string"
}
a1_traffic-engineering_schema:
MPLS Traffic Engingeering parameters for LDP
- auto-tunnel-mesh: object
-
MPLS Traffic Engineering auto-tunnel mesh parameters for LDP
-
- group-all: null
-
Enable all MPLS TE auto-tunnel mesh-group interfaces
- group-ids: object
-
Enable interfaces in specific MPLS TE auto-tunnel mesh-groups
-
- group-id: object[]
-
Auto-mesh group identifier to enable
-
object - mesh-group-id: string
-
Mesh group ID
Example
{
"auto-tunnel-mesh": {
"group-all": [ null ],
"group-ids": {
"group-id": [
{
"mesh-group-id": "string"
}
]
}
}
}
a1_auto-tunnel-mesh_schema:
MPLS Traffic Engineering auto-tunnel mesh parameters for LDP
- group-all: null
-
Enable all MPLS TE auto-tunnel mesh-group interfaces
- group-ids: object
-
Enable interfaces in specific MPLS TE auto-tunnel mesh-groups
-
- group-id: object[]
-
Auto-mesh group identifier to enable
-
object - mesh-group-id: string
-
Mesh group ID
Example
{
"group-all": [ null ],
"group-ids": {
"group-id": [
{
"mesh-group-id": "string"
}
]
}
}
a1_group-ids_schema:
Enable interfaces in specific MPLS TE auto-tunnel mesh-groups
- group-id: object[]
-
Auto-mesh group identifier to enable
-
object - mesh-group-id: string
-
Mesh group ID
Example
{
"group-id": [
{
"mesh-group-id": "string"
}
]
}
a1_neighbor_schema:
Configuration related to Neighbors
- password: string
-
Default password for all neigbors
- ldp-ids: object
-
Configuration related to Neighbors using LDP Id
-
- ldp-id: object[]
-
LDP ID based configuration related to a neigbor
-
object - lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"password": "string",
"ldp-ids": {
"ldp-id": [
{
"lsr-id": "string",
"password": {
"command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
]
}
}
a1_addresses_schema:
Configuration related to neighbors using neighbor address
- address: object[]
-
IP address based configuration related to a neighbor
-
object - targeted: null
-
Establish targeted session with given address
- ip-address: string
-
The IP address
Example
{
"address": [
{
"targeted": [ null ],
"ip-address": "string"
}
]
}
a1_address_schema:
- targeted: null
-
Establish targeted session with given address
- ip-address: string
-
The IP address
Example
{
"targeted": [ null ],
"ip-address": "string"
}
a1_redistribution-protocol_schema:
MPLS LDP configuration for protocol redistribution
- bgp: object
-
MPLS LDP configuration for protocol redistribution
-
- as: object
-
MPLS LDP configuration for protocol redistribution
-
- as-xx: integer
-
First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.
range:"0..65535" - as-yy: integer
-
Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.
range:"0..4294967295"
- advertise-to: object
-
ACL containing list of neighbors for BGP route redistribution
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
advertise to peer acl type
Example
{
"bgp": {
"as": {
"as-xx": "integer",
"as-yy": "integer"
},
"advertise-to": {
"peer-acl-name": "string",
"type": "string"
}
}
}
a1_bgp_schema:
MPLS LDP configuration for protocol redistribution
- as: object
-
MPLS LDP configuration for protocol redistribution
-
- as-xx: integer
-
First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.
range:"0..65535" - as-yy: integer
-
Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.
range:"0..4294967295"
- advertise-to: object
-
ACL containing list of neighbors for BGP route redistribution
-
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
advertise to peer acl type
Example
{
"as": {
"as-xx": "integer",
"as-yy": "integer"
},
"advertise-to": {
"peer-acl-name": "string",
"type": "string"
}
}
a1_as_schema:
MPLS LDP configuration for protocol redistribution
- as-xx: integer
-
First half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if second half is zero.
range:"0..65535" - as-yy: integer
-
Second half of BGP AS number in XX.YY format. Mandatory Must be a non-zero value if first half is zero.
range:"0..4294967295"
Example
{
"as-xx": "integer",
"as-yy": "integer"
}
a1_advertise-to_schema:
ACL containing list of neighbors for BGP route redistribution
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
advertise to peer acl type
Example
{
"peer-acl-name": "string",
"type": "string"
}
a1_global_schema:
Global configuration for MPLS LDP
- entropy-label: object
-
Configure for LDP Entropy-Label
-
- enable: null
-
none
- igp: object
-
LDP IGP configuration
-
- sync: object
-
LDP IGP synchronization
-
- delay: object
-
LDP IGP synchronization delay time
-
- on-proc-restart: integer
-
Global sync up delay to be used after process restart
range:"60..600" units:"second" - on-session-up: integer
-
Interface sync up delay after session up
range:"5..300" units:"second"
- mldp:
-
MPLS mLDP configuration
- discovery: object
-
Configure Discovery parameters
-
- targeted-hello: object
-
LDP Targeted Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Targeted Hello interval
- disable-quick-start: null
-
Disable discovery's quick start mode
- link-hello: object
-
LDP Link Hellos
-
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Link Hello interval
- disable-instance-tlv: null
-
Disable transmit and receive processing for private Instance TLV in LDP discovery hello messages
- ltrace-buf-multiplier: integer
-
Configure Ltrace Buffer Multiplier
range:"1..5" default:"1" - session: object
-
LDP Session parameters
-
- hold-time: integer
-
LDP Session holdtime
range:"15..65535" units:"second" default:"180" - backoff-time: object
-
Configure Session Backoff parameters
-
- max-backoff-time: integer
-
Maximum session backoff time (seconds)
range:"5..2147483" units:"second" default:"120" - initial-backoff-time: integer
-
Initial session backoff time (seconds)
range:"5..2147483" units:"second" default:"15"
- disable-implicit-ipv4: null
-
Disable the implicit enabling for IPv4 address family
- signalling: object
-
Configure LDP signalling parameters
-
- dscp: string
-
DSCP for control packets
- enable-logging: object
-
Enable logging of events
-
- nsr: null
-
Enable logging of NSR events
- adjacency: null
-
Enable logging of adjacency events
- session-protection: null
-
Enable logging of session protection events
- neighbor-changes: null
-
Enable logging of neighbor events
- gr-session-changes: null
-
Enable logging of Graceful Restart (GR) events
- nsr: object
-
Configure LDP Non-Stop Routing
-
- enable: null
-
none
- graceful-restart: object
-
Configuration for LDP Graceful Restart parameters
-
- reconnect-timeout: integer
-
Configure Graceful Restart Reconnect Timeout value
range:"60..1800" units:"second" default:"120" - enable: null
-
none
- forwarding-hold-time: integer
-
Configure Graceful Restart Session holdtime
range:"60..1800" units:"second" default:"180"
Example
{
"entropy-label": {
"enable": [ null ]
},
"igp": {
"sync": {
"delay": {
"on-proc-restart": "integer",
"on-session-up": "integer"
}
}
},
"mldp": {
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
}
]
},
"mldp-global": {
"logging": {
"notifications": [ null ]
}
},
"default-vrf": {
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
},
"discovery": {
"targeted-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-quick-start": [ null ],
"link-hello": {
"hold-time": "string",
"interval": "string"
},
"disable-instance-tlv": [ null ]
},
"ltrace-buf-multiplier": "integer",
"session": {
"hold-time": "integer",
"backoff-time": {
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
},
"disable-implicit-ipv4": [ null ],
"signalling": {
"dscp": "string"
},
"enable-logging": {}
}
a1_session_schema:
LDP Session parameters
- hold-time: integer
-
LDP Session holdtime
range:"15..65535" units:"second" default:"180" - backoff-time: object
-
Configure Session Backoff parameters
-
- max-backoff-time: integer
-
Maximum session backoff time (seconds)
range:"5..2147483" units:"second" default:"120" - initial-backoff-time: integer
-
Initial session backoff time (seconds)
range:"5..2147483" units:"second" default:"15"
Example
{
"hold-time": "integer",
"backoff-time": {
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
}
a1_protection_schema:
Configure Session Protection parameters
- peer-acl-name: string
-
Name of peer ACL
- protection-type: string all, for, all-with-duration, for-with-duration, all-with-forever, for-with-forever
-
Session protection type
- duration: integer
-
Holdup duration
range:"30..2147483"
Example
{
"peer-acl-name": "string",
"protection-type": "string",
"duration": "integer"
}
a1_downstream-on-demand_schema:
ACL with the list of neighbors configured for Downstream on Demand
- peer-acl-name: string
-
Name of peer ACL
- type: string peer-acl
-
Downstream on demand type
Example
{
"peer-acl-name": "string",
"type": "string"
}
a1_ldp-ids_schema:
Configuration related to Neighbors using LDP Id
- ldp-id: object[]
-
LDP ID based configuration related to a neigbor
-
object - lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"ldp-id": [
{
"lsr-id": "string",
"password": {
"command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
]
}
a1_ldp-id_schema:
- lsr-id: string
-
LSR ID of neighbor
- password: object
-
Password for MD5 authentication for this neighbor
-
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
- label-space-id: integer
-
Label space ID of neighbor
Example
{
"lsr-id": "string",
"password": {
"command-type": "string",
"password": "string"
},
"label-space-id": "integer"
}
a1_password_schema:
Password for MD5 authentication for this neighbor
- command-type: string disable, specified
-
Command type for password configuration
- password: string
-
The neighbor password
Example
{
"command-type": "string",
"password": "string"
}
a1_dual-stack_schema:
Configuration related to neighbor transport
- tlv-compliance: null
-
Configuration to enable neighbor dual-stack tlv-compliance
- transport-connection: object
-
Configuration related to neighbor transport
-
- max-wait: integer
-
Configuration related to neighbor dual-stack xport-connection max-wait
range:"0..60" units:"second" - prefer: object
-
Configuration related to neighbor dual-stack xport-connection preference
-
- ipv4: null
-
Configuration related to neighbor dual-stack xport-connection preference ipv4
Example
{
"tlv-compliance": [ null ],
"transport-connection": {
"max-wait": "integer",
"prefer": {
"ipv4": [ null ]
}
}
}
a1_transport-connection_schema:
Configuration related to neighbor transport
- max-wait: integer
-
Configuration related to neighbor dual-stack xport-connection max-wait
range:"0..60" units:"second" - prefer: object
-
Configuration related to neighbor dual-stack xport-connection preference
-
- ipv4: null
-
Configuration related to neighbor dual-stack xport-connection preference ipv4
Example
{
"max-wait": "integer",
"prefer": {
"ipv4": [ null ]
}
}
a1_prefer_schema:
Configuration related to neighbor dual-stack xport-connection preference
- ipv4: null
-
Configuration related to neighbor dual-stack xport-connection preference ipv4
Example
{
"ipv4": [ null ]
}
a1_graceful-restart_schema:
Configuration for LDP Graceful Restart parameters
- reconnect-timeout: integer
-
Configure Graceful Restart Reconnect Timeout value
range:"60..1800" units:"second" default:"120" - enable: null
-
none
- forwarding-hold-time: integer
-
Configure Graceful Restart Session holdtime
range:"60..1800" units:"second" default:"180"
Example
{
"reconnect-timeout": "integer",
"enable": [ null ],
"forwarding-hold-time": "integer"
}
a1_helper-peer_schema:
Configure parameters related to GR peer(s) opearating in helper mode
- maintain-on-local-reset: string
-
Maintain the state of a GR peer upon a local reset
Example
{
"maintain-on-local-reset": "string"
}
a1_transport-address_schema:
MPLS LDP configuration for interface discovery transportaddress.
- address-type: string interface, address
-
Transport address option
- address: string
-
IP address
Example
{
"address-type": "string",
"address": "string"
}
a1_igp_schema:
LDP IGP configuration
- sync: object
-
LDP IGP synchronization
-
- delay: object
-
LDP IGP synchronization delay time
-
- on-proc-restart: integer
-
Global sync up delay to be used after process restart
range:"60..600" units:"second" - on-session-up: integer
-
Interface sync up delay after session up
range:"5..300" units:"second"
Example
{
"sync": {
"delay": {
"on-proc-restart": "integer",
"on-session-up": "integer"
}
}
}
a1_mldp_schema:
MPLS mLDP configuration
- vrfs: object
-
VRF Table attribute configuration for MPLS LDP
-
- vrf: object[]
-
VRF attribute configuration for MPLS LDP
-
- vrf-name: string
-
VRF Name
- mldp-global: object
-
Global configuration for mLDP
-
- logging: object
-
MPLS mLDP logging
-
- notifications: null
-
MPLS mLDP logging notifications
- default-vrf: AF-TABLE
-
Default VRF attribute configuration for mLDP
Example
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
}
]
},
"mldp-global": {
"logging": {
"notifications": [ null ]
}
},
"default-vrf": {
"afs": {
"af": [
{
"mldp-rib-unicast-always": [ null ],
"enable": [ null ],
"neighbor-policies": {
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
},
"recursive-forwarding": {
"policy": "string",
"enable": [ null ]
},
"csc": {
"enable": [ null ]
},
"af-name": "string",
"make-before-break": {
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
},
"mldp-recursive-fec": {
"policy": "string",
"enable": [ null ]
},
"mo-frr": {
"policy": "string",
"enable": [ null ]
}
}
]
}
},
"enable": [ null ]
}
a1_link-hello_schema:
LDP Link Hellos
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Link Hello interval
Example
{
"hold-time": "string",
"interval": "string"
}
a1_sync_schema:
LDP IGP synchronization
- delay: object
-
LDP IGP synchronization delay time
-
- on-proc-restart: integer
-
Global sync up delay to be used after process restart
range:"60..600" units:"second" - on-session-up: integer
-
Interface sync up delay after session up
range:"5..300" units:"second"
Example
{
"delay": {
"on-proc-restart": "integer",
"on-session-up": "integer"
}
}
a1_delay_schema:
LDP IGP synchronization delay time
- on-proc-restart: integer
-
Global sync up delay to be used after process restart
range:"60..600" units:"second" - on-session-up: integer
-
Interface sync up delay after session up
range:"5..300" units:"second"
Example
{
"on-proc-restart": "integer",
"on-session-up": "integer"
}
a1_on-session-up_schema:
Interface sync up delay after session up
- disable: null
-
Disable delay after session up
- timeout: integer
-
Time (seconds)
range:"1..600000" units:"second"
Example
{
"disable": [ null ],
"timeout": "integer"
}
a1_vrfs_schema:
SNMP VRF configuration commands
- vrf: object[]
-
VRF name
-
- name: string
-
VRF name
Example
{
"vrf": [
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
a1_vrf_schema:
- name: string
-
VRF name
Example
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
a1_entropy-label_schema:
Configure for LDP Entropy-Label
- enable: null
-
none
Example
{
"enable": [ null ]
}
a1_backoff-time_schema:
Configure Session Backoff parameters
- max-backoff-time: integer
-
Maximum session backoff time (seconds)
range:"5..2147483" units:"second" default:"120" - initial-backoff-time: integer
-
Initial session backoff time (seconds)
range:"5..2147483" units:"second" default:"15"
Example
{
"max-backoff-time": "integer",
"initial-backoff-time": "integer"
}
a1_enable-logging_schema:
Enable logging of events
- nsr: null
-
Enable logging of NSR events
- adjacency: null
-
Enable logging of adjacency events
- session-protection: null
-
Enable logging of session protection events
- neighbor-changes: null
-
Enable logging of neighbor events
- gr-session-changes: null
-
Enable logging of Graceful Restart (GR) events
Example
{
"nsr": [ null ],
"adjacency": [ null ],
"session-protection": [ null ],
"neighbor-changes": [ null ],
"gr-session-changes": [ null ]
}
a1_signalling_schema:
Configure LDP signalling parameters
- dscp: string
-
DSCP for control packets
Example
{
"dscp": "string"
}
a1_targeted-hello_schema:
LDP Targeted Hellos
- hold-time: string
-
Time (seconds) - 65535 implies infinite
- interval: string
-
Targeted Hello interval
Example
{
"hold-time": "string",
"interval": "string"
}
a1_recursive-forwarding_schema:
Enable recursive forwarding
- policy: string
-
Recursive forwarding policy name
- enable: null
-
Enable recursive forwarding
Example
{
"policy": "string",
"enable": [ null ]
}
a1_mldp-recursive-fec_schema:
MPLS mLDP Recursive FEC
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP Recursive FEC
Example
{
"policy": "string",
"enable": [ null ]
}
a1_neighbor-policies_schema:
MLDP neighbor policies
- neighbor-policy: object[]
-
Route Policy
-
object - route-policy: string
-
Route policy name
- root-address: string
-
Neighbor Address
- policy-mode: string inbound, outbound
-
Inbound/Outbound Policy
Example
{
"neighbor-policy": [
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
]
}
a1_neighbor-policy_schema:
- route-policy: string
-
Route policy name
- root-address: string
-
Neighbor Address
- policy-mode: string inbound, outbound
-
Inbound/Outbound Policy
Example
{
"route-policy": "string",
"root-address": "string",
"policy-mode": "string"
}
a1_mo-frr_schema:
MPLS mLDP MoFRR
- policy: string
-
Route policy name
- enable: null
-
Enable MPLS mLDP MoFRR
Example
{
"policy": "string",
"enable": [ null ]
}
a1_make-before-break_schema:
MPLS mLDP Make-Before-Break configuration
- policy: string
-
Route policy name
- signaling: object
-
Enable MPLS mLDP MBB signaling
-
- forward-delay: integer
-
Forwarding Delay in Seconds
range:"0..600" units:"second" - delete-delay: integer
-
Delete Delay in seconds
range:"0..60" units:"second"
Example
{
"policy": "string",
"signaling": {
"forward-delay": "integer",
"delete-delay": "integer"
}
}
a1_signaling_schema:
Enable MPLS mLDP MBB signaling
- forward-delay: integer
-
Forwarding Delay in Seconds
range:"0..600" units:"second" - delete-delay: integer
-
Delete Delay in seconds
range:"0..60" units:"second"
Example
{
"forward-delay": "integer",
"delete-delay": "integer"
}
a1_mldp-global_schema:
Global configuration for mLDP
- logging: object
-
MPLS mLDP logging
-
- notifications: null
-
MPLS mLDP logging notifications
Example
{
"logging": {
"notifications": [ null ]
}
}
a1_logging_schema:
SNMP logging
- threshold: object
-
SNMP logging threshold
-
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"threshold": {
"oid-processing": "integer",
"pdu-processing": "integer"
}
}
TRAP-HOST-TABLE:
Common node of snmp, vrf
- trap-hosts: object
-
Specify hosts to receive SNMP notifications
-
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-hosts": {
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
}
APPLIED-TO:
Common node of rule, rule-set
- applied-to: object
-
Applied to the Rule or Ruleset
-
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
CONTEXT-MAPPING-TABLE:
Common node of snmp, vrf
- context-mappings: object
-
List of context names
-
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
VAR-BIND-TABLE:
Common node of root-cause, non-root-cause
- var-binds: object
-
Varbinds to match
-
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
CONTEXT-TABLE:
Common node of snmp, vrf
- contexts: object
-
List of Context Names
-
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"contexts": {
"context": [
{
"context-name": "string"
}
]
}
}
a1_snmp_schema:
SNMP notification configuration
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
a1_encrypted-community-maps_schema:
Container class to hold clear/encrypted communitie maps
- encrypted-community-map: object[]
-
Clear/encrypted SNMP community map
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"encrypted-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_encrypted-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_views_schema:
Class to configure a SNMPv2 MIB view
- view: object[]
-
Name of the view
-
object - view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view": [
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
]
}
a1_view_schema:
- view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
a1_threshold_schema:
SNMP logging threshold
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
a1_administration_schema:
Container class for SNMP administration
- default-communities: object
-
Container class to hold unencrpted communities
-
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- encrypted-communities: object
-
Container class to hold clear/encrypted communities
-
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-communities": {
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
},
"encrypted-communities": {
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
a1_default-communities_schema:
Container class to hold unencrpted communities
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_default-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_encrypted-communities_schema:
Container class to hold clear/encrypted communities
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_encrypted-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_agent_schema:
The heirarchy point for SNMP Agent configurations
- engine-id: object
-
SNMPv3 engineID
-
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"engine-id": {
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
}
a1_engine-id_schema:
SNMPv3 engineID
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
a1_remotes_schema:
SNMPv3 remote SNMP Entity
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
}
a1_trap_schema:
Class to hold trap configurations
- queue-length: integer
-
Message queue length for each TRAP host
range:"1..5000" - throttle-time: integer
-
Set throttle time for handling traps
range:"50..1000" units:"millisecond" - timeout: integer
-
Timeout for TRAP message retransmissions
range:"1..600000" units:"second"
Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
a1_drop-packet_schema:
SNMP packet drop config
- unknown-user: null
-
Enable drop unknown user name
Example
{
"unknown-user": [ null ]
}
a1_ipv6_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_tos_schema:
Type of TOS
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
a1_ipv4_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_system_schema:
container to hold system information
- chassis-id: string
-
String to uniquely identify this chassis
- contact: string
-
identification of the contact person for this managed node
- location: string
-
The physical location of this node
Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
a1_target_schema:
- target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
a1_targets_schema:
List of targets
- target: object[]
-
Name of the target list
-
object - target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target": [
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
]
}
a1_vrf-names_schema:
List of VRF Name for a target list
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"vrf-name": [
{
"name": "string"
}
]
}
a1_target-addresses_schema:
SNMP Target address configurations
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
Example
{
"target-address": [
{
"ip-address": "string"
}
]
}
a1_notification_schema:
Enable SNMP notifications
- snmp: object
-
SNMP notification configuration
-
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
- mpls-ldp: object
-
MPLS-LDP-STD-MIB notification configuration
-
- session-up: null
-
Enable mplsLdpSessionUp notification
- session-down: null
-
Enable mplsLdpSessionDown notification
- init-session-threshold-exceeded: null
-
Enable mplsLdpInitSessionThresholdExceeded notification
Example
{
"snmp": {
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
},
"mpls-ldp": {
"session-up": [ null ],
"session-down": [ null ],
"init-session-threshold-exceeded": [ null ]
}
}
a1_correlator_schema:
Configure properties of the trap correlator
- rules: object
-
Table of configured rules
-
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"second" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
- rule-sets: object
-
Table of configured rulesets
-
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
- buffer-size: integer
-
Configure size of the correlator buffer
range:"1024..2147483647" units:"byte"
Example
{
"rules": {
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"rule-sets": {
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
a1_rules_schema:
Table of configured rules
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"second" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule_schema:
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"second" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_root-causes_schema:
Table of configured rootcause (only one entry allowed)
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_root-cause_schema:
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_var-binds_schema:
Varbinds to match
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
a1_var-bind_schema:
- oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
a1_match_schema:
VarBind match conditions
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"index": "string",
"value": "string"
}
a1_non-root-causes_schema:
Table of configured non-rootcause
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_non-root-cause_schema:
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_applied-to_schema:
Applied to the Rule or Ruleset
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
a1_hosts_schema:
Table of configured hosts to apply rules to
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
a1_host_schema:
- port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"port": "string",
"ip-address": "string"
}
a1_rule-sets_schema:
Table of configured rulesets
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule-set_schema:
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_rulenames_schema:
Table of configured rulenames
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rulename": [
{
"rulename": "string"
}
]
}
a1_bulk-stats_schema:
SNMP bulk stats configuration commands
- memory: integer
-
per process memory limit in kilo bytes
range:"100..200000" units:"kilobyte" - transfers: object
-
Periodicity for the transfer of bulk data in minutes
-
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
- objects: object
-
Configure an Object List
-
- object: object[]
-
Name of the object List
-
object - object-list-name: string
-
Name of the object List
- objects: object
-
Configure an object List
-
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
- type: null
-
Configure object list name
- schemas: object
-
Configure schema definition
-
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"memory": "integer",
"transfers": {
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
},
"objects": {
"object": [
{
"object-list-name": "string",
"objects": {
"object": [
{
"oid": "string"
}
]
},
"type": [ null ]
}
]
},
"schemas": {
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
a1_schemas_schema:
Configure schema definition
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
a1_schema_schema:
- schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
a1_instance_schema:
Object instance information
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
a1_objects_schema:
Configure an object List
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
Example
{
"object": [
{
"oid": "string"
}
]
}
a1_transfers_schema:
Periodicity for the transfer of bulk data in minutes
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
a1_transfer_schema:
- retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
a1_transfer-schemas_schema:
Schema that contains objects to be collected
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
Example
{
"transfer-schema": [
{
"schema-name": "string"
}
]
}
a1_transfer-schema_schema:
- schema-name: string
-
Schema that contains objects to be collected
Example
{
"schema-name": "string"
}
a1_default-community-maps_schema:
Container class to hold unencrpted community map
- default-community-map: object[]
-
Unencrpted SNMP community map name
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"default-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_default-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_overload-control_schema:
Set overload control params for handling incoming messages
- drop-time: integer
-
Drop time in seconds for incoming queue (default 1 sec)
range:"0..300" units:"second" - throttle-rate: integer
-
Throttle time in milliseconds for incoming queue (default 500 msec)
range:"0..1000" units:"millisecond"
Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
a1_timeouts_schema:
SNMP timeouts
- duplicates: integer
-
Duplicate request feature timeout
range:"0..20" units:"second" default:"1" - threshold: integer
-
Threshold request feature timeout
range:"0..100000" units:"second" default:"50000" - pdu-stats: integer
-
SNMP pdu statistics timeout
range:"1..10" units:"second" default:"2" - in-qdrop: integer
-
incoming queue drop feature timeout
range:"0..20" units:"second" default:"10" - subagent: integer
-
Sub-Agent Request timeout
range:"1..20" units:"second" default:"10"
Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
a1_users_schema:
Define a user who can access the SNMP engine
- user: object[]
-
Name of the user
-
object - v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"user": [
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
a1_user_schema:
- v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
a1_trap-hosts_schema:
Specify hosts to receive SNMP notifications
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
a1_trap-host_schema:
- encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a trap host
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-host_schema:
Container class for defining notification type for a Inform host
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_inform-user-communities_schema:
Container class for defining communities for a inform host
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a inform host
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_default-user-communities_schema:
Container class for defining communities for a trap host
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_default-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_contexts_schema:
List of Context Names
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"context": [
{
"context-name": "string"
}
]
}
a1_context-mappings_schema:
List of context names
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
a1_context-mapping_schema:
- context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
a1_groups_schema:
Define a User Security Model group
- group: object[]
-
Name of the group
-
object - name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"group": [
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
a1_group_schema:
- name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}